FMIceLinkHttpRequestArgs Class Reference

Inherits from FMIceLinkDynamic : FMIceLinkSerializable : NSObject
Declared in FMIceLinkHttpRequestArgs.h
FMIceLinkHttpRequestArgs.m

Overview

Arguments for sending an HTTP request.

– binaryContent

Gets the binary content to transfer over HTTP. Overrides FMIceLinkHttpRequestArgs#[textContent](#//api/name/textContent).
- (NSMutableData *)binaryContent

Discussion

Gets the binary content to transfer over HTTP. Overrides FMIceLinkHttpRequestArgs#[textContent](#//api/name/textContent).

Declared In

FMIceLinkHttpRequestArgs.h

– headers

Gets the headers to transfer over HTTP.
- (FMIceLinkNameValueCollection *)headers

Discussion

Gets the headers to transfer over HTTP.

Declared In

FMIceLinkHttpRequestArgs.h

+ httpRequestArgs

Initializes a new instance of the FMIceLinkHttpRequestArgs class with default values.
+ (FMIceLinkHttpRequestArgs *)httpRequestArgs

Discussion

Initializes a new instance of the FMIceLinkHttpRequestArgs class with default values.

Declared In

FMIceLinkHttpRequestArgs.h

– init

Initializes a new instance of the FMIceLinkHttpRequestArgs class with default values.
- (instancetype)init

Discussion

Initializes a new instance of the FMIceLinkHttpRequestArgs class with default values.

Declared In

FMIceLinkHttpRequestArgs.h

– method

Gets the HTTP method.
- (FMIceLinkHttpMethod)method

Discussion

Gets the HTTP method.

Declared In

FMIceLinkHttpRequestArgs.h

– onRequestCreated

Gets the callback to invoke once the outgoing HTTP request is created. See [FMIceLinkHttpRequestCreatedArgs](../Classes/FMIceLinkHttpRequestCreatedArgs.html) for callback argument details.
- (FMIceLinkAction1 *)onRequestCreated

Discussion

Gets the callback to invoke once the outgoing HTTP request is created. See [FMIceLinkHttpRequestCreatedArgs](../Classes/FMIceLinkHttpRequestCreatedArgs.html) for callback argument details.

Declared In

FMIceLinkHttpRequestArgs.h

– onResponseReceived

Gets the callback to invoke once the incoming HTTP response has been received. See [FMIceLinkHttpResponseReceivedArgs](../Classes/FMIceLinkHttpResponseReceivedArgs.html) for callback argument details.
- (FMIceLinkAction1 *)onResponseReceived

Discussion

Gets the callback to invoke once the incoming HTTP response has been received. See [FMIceLinkHttpResponseReceivedArgs](../Classes/FMIceLinkHttpResponseReceivedArgs.html) for callback argument details.

Declared In

FMIceLinkHttpRequestArgs.h

– sender

Gets the sender of the content, either a client or publisher.
- (id)sender

Discussion

Gets the sender of the content, either a client or publisher.

Declared In

FMIceLinkHttpRequestArgs.h

– setBinaryContent:

Sets the binary content to transfer over HTTP. Overrides FMIceLinkHttpRequestArgs#[textContent](#//api/name/textContent).
- (void)setBinaryContent:(NSMutableData *)value

Discussion

Sets the binary content to transfer over HTTP. Overrides FMIceLinkHttpRequestArgs#[textContent](#//api/name/textContent).

Declared In

FMIceLinkHttpRequestArgs.h

– setHeaders:

Sets the [headers](#//api/name/headers) to transfer over HTTP.
- (void)setHeaders:(FMIceLinkNameValueCollection *)value

Discussion

Sets the [headers](#//api/name/headers) to transfer over HTTP.

Declared In

FMIceLinkHttpRequestArgs.h

– setMethod:

Sets the HTTP [method](#//api/name/method).
- (void)setMethod:(FMIceLinkHttpMethod)value

Discussion

Sets the HTTP [method](#//api/name/method).

Declared In

FMIceLinkHttpRequestArgs.h

– setOnRequestCreated:

Sets the callback to invoke once the outgoing HTTP request is created. See [FMIceLinkHttpRequestCreatedArgs](../Classes/FMIceLinkHttpRequestCreatedArgs.html) for callback argument details.
- (void)setOnRequestCreated:(FMIceLinkAction1 *)value

Discussion

Sets the callback to invoke once the outgoing HTTP request is created. See [FMIceLinkHttpRequestCreatedArgs](../Classes/FMIceLinkHttpRequestCreatedArgs.html) for callback argument details.

Declared In

FMIceLinkHttpRequestArgs.h

– setOnRequestCreatedBlock

Sets the callback to invoke once the outgoing HTTP request is created. See [FMIceLinkHttpRequestCreatedArgs](../Classes/FMIceLinkHttpRequestCreatedArgs.html) for callback argument details.
- (void ( ^ ) ( void ( ^ ) ( FMIceLinkHttpRequestCreatedArgs *) ))setOnRequestCreatedBlock

Discussion

Sets the callback to invoke once the outgoing HTTP request is created. See [FMIceLinkHttpRequestCreatedArgs](../Classes/FMIceLinkHttpRequestCreatedArgs.html) for callback argument details.

Declared In

FMIceLinkHttpRequestArgs.h

– setOnRequestCreatedBlock:

Sets the callback to invoke once the outgoing HTTP request is created. See [FMIceLinkHttpRequestCreatedArgs](../Classes/FMIceLinkHttpRequestCreatedArgs.html) for callback argument details.
- (void)setOnRequestCreatedBlock:(void ( ^ ) ( FMIceLinkHttpRequestCreatedArgs *))valueBlock

Discussion

Sets the callback to invoke once the outgoing HTTP request is created. See [FMIceLinkHttpRequestCreatedArgs](../Classes/FMIceLinkHttpRequestCreatedArgs.html) for callback argument details.

Declared In

FMIceLinkHttpRequestArgs.h

– setOnResponseReceived:

Sets the callback to invoke once the incoming HTTP response has been received. See [FMIceLinkHttpResponseReceivedArgs](../Classes/FMIceLinkHttpResponseReceivedArgs.html) for callback argument details.
- (void)setOnResponseReceived:(FMIceLinkAction1 *)value

Discussion

Sets the callback to invoke once the incoming HTTP response has been received. See [FMIceLinkHttpResponseReceivedArgs](../Classes/FMIceLinkHttpResponseReceivedArgs.html) for callback argument details.

Declared In

FMIceLinkHttpRequestArgs.h

– setOnResponseReceivedBlock

Sets the callback to invoke once the incoming HTTP response has been received. See [FMIceLinkHttpResponseReceivedArgs](../Classes/FMIceLinkHttpResponseReceivedArgs.html) for callback argument details.
- (void ( ^ ) ( void ( ^ ) ( FMIceLinkHttpResponseReceivedArgs *) ))setOnResponseReceivedBlock

Discussion

Sets the callback to invoke once the incoming HTTP response has been received. See [FMIceLinkHttpResponseReceivedArgs](../Classes/FMIceLinkHttpResponseReceivedArgs.html) for callback argument details.

Declared In

FMIceLinkHttpRequestArgs.h

– setOnResponseReceivedBlock:

Sets the callback to invoke once the incoming HTTP response has been received. See [FMIceLinkHttpResponseReceivedArgs](../Classes/FMIceLinkHttpResponseReceivedArgs.html) for callback argument details.
- (void)setOnResponseReceivedBlock:(void ( ^ ) ( FMIceLinkHttpResponseReceivedArgs *))valueBlock

Discussion

Sets the callback to invoke once the incoming HTTP response has been received. See [FMIceLinkHttpResponseReceivedArgs](../Classes/FMIceLinkHttpResponseReceivedArgs.html) for callback argument details.

Declared In

FMIceLinkHttpRequestArgs.h

– setSender:

Sets the [sender](#//api/name/sender) of the content, either a client or publisher.
- (void)setSender:(id)value

Discussion

Sets the [sender](#//api/name/sender) of the content, either a client or publisher.

Declared In

FMIceLinkHttpRequestArgs.h

– setTextContent:

Sets the text content to transfer over HTTP.
- (void)setTextContent:(NSString *)value

Discussion

Sets the text content to transfer over HTTP.

Declared In

FMIceLinkHttpRequestArgs.h

– setTimeout:

Sets the number of milliseconds to wait before timing out the HTTP transfer. Defaults to 15000 ms (15 seconds).
- (void)setTimeout:(int)value

Discussion

Sets the number of milliseconds to wait before timing out the HTTP transfer. Defaults to 15000 ms (15 seconds).

Declared In

FMIceLinkHttpRequestArgs.h

– setUrl:

Sets the target URL for the HTTP request.
- (void)setUrl:(NSString *)value

Discussion

Sets the target URL for the HTTP request.

Declared In

FMIceLinkHttpRequestArgs.h

– textContent

Gets the text content to transfer over HTTP.
- (NSString *)textContent

Discussion

Gets the text content to transfer over HTTP.

Declared In

FMIceLinkHttpRequestArgs.h

– timeout

Gets the number of milliseconds to wait before timing out the HTTP transfer. Defaults to 15000 ms (15 seconds).
- (int)timeout

Discussion

Gets the number of milliseconds to wait before timing out the HTTP transfer. Defaults to 15000 ms (15 seconds).

Declared In

FMIceLinkHttpRequestArgs.h

– url

Gets the target URL for the HTTP request.
- (NSString *)url

Discussion

Gets the target URL for the HTTP request.

Declared In

FMIceLinkHttpRequestArgs.h