FMLiveSwitchHttpRequestArgs Class Reference

Arguments for sending an HTTP request. More...

Instance Methods

(NSMutableData *) - binaryContent
 Gets the binary content to transfer over HTTP. More...
 
(FMLiveSwitchNameValueCollection *) - headers
 Gets the headers to transfer over HTTP. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchHttpRequestArgs class with default values. More...
 
(int) - maxRetries
 Gets the maximum number of retries allowed. More...
 
(FMLiveSwitchHttpMethod) - method
 Gets the HTTP method. More...
 
(FMLiveSwitchAction1< FMLiveSwitchHttpRequestCreatedArgs * > *) - onRequestCreated
 Gets the callback to invoke once the outgoing HTTP request is created. More...
 
(FMLiveSwitchAction1< FMLiveSwitchHttpResponseReceivedArgs * > *) - onResponseReceived
 Gets the callback to invoke once the incoming HTTP response has been received. More...
 
(id- sender
 Gets the sender of the content, either a client or publisher. More...
 
(void) - setBinaryContent:
 Sets the binary content to transfer over HTTP. More...
 
(void) - setHeaders:
 Sets the headers to transfer over HTTP. More...
 
(void) - setMaxRetries:
 Sets the maximum number of retries allowed. More...
 
(void) - setMethod:
 Sets the HTTP method. More...
 
(void) - setOnRequestCreated:
 Sets the callback to invoke once the outgoing HTTP request is created. More...
 
(FMLiveSwitchHttpRequestCreatedArgs *) - setOnRequestCreatedBlock
 Sets the callback to invoke once the outgoing HTTP request is created. More...
 
(void) - setOnRequestCreatedBlock:
 Sets the callback to invoke once the outgoing HTTP request is created. More...
 
(void) - setOnResponseReceived:
 Sets the callback to invoke once the incoming HTTP response has been received. More...
 
(FMLiveSwitchHttpResponseReceivedArgs *) - setOnResponseReceivedBlock
 Sets the callback to invoke once the incoming HTTP response has been received. More...
 
(void) - setOnResponseReceivedBlock:
 Sets the callback to invoke once the incoming HTTP response has been received. More...
 
(void) - setSender:
 Sets the sender of the content, either a client or publisher. More...
 
(void) - setTextContent:
 Sets the text content to transfer over HTTP. More...
 
(void) - setTimeout:
 Sets the number of milliseconds to wait before timing out the HTTP transfer. More...
 
(void) - setUrl:
 Sets the target URL for the HTTP request. More...
 
(NSString *) - textContent
 Gets the text content to transfer over HTTP. More...
 
(int) - timeout
 Gets the number of milliseconds to wait before timing out the HTTP transfer. More...
 
(NSString *) - url
 Gets the target URL for the HTTP request. More...
 
- Instance Methods inherited from FMLiveSwitchDynamic
(NSMutableDictionary< NSString *, id > *) - dynamicProperties
 Gets all dynamic properties on this instance. More...
 
(id- getDynamicValueWithKey:
 Gets a property value from the local cache. More...
 
(void) - setDynamicValueWithKey:value:
 Sets a property value in the local cache. More...
 
(bool) - unsetDynamicValueWithKey:
 Removes a property value from the local cache. More...
 

Class Methods

(FMLiveSwitchHttpRequestArgs *) + httpRequestArgs
 Initializes a new instance of the FMLiveSwitchHttpRequestArgs class with default values. More...
 
- Class Methods inherited from FMLiveSwitchDynamic
(FMLiveSwitchDynamic *) + dynamic
 
- Class Methods inherited from FMLiveSwitchSerializable
(FMLiveSwitchSerializable *) + serializable
 Initializes a new instance of the FMLiveSwitchSerializable class. More...
 

Detailed Description

Arguments for sending an HTTP request.

Method Documentation

◆ binaryContent

- (NSMutableData*) binaryContent

Gets the binary content to transfer over HTTP.

Overrides textContent.

◆ headers

- (FMLiveSwitchNameValueCollection*) headers

Gets the headers to transfer over HTTP.

◆ httpRequestArgs

+ (FMLiveSwitchHttpRequestArgs*) httpRequestArgs

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

◆ init

- (instancetype) init

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

Implements FMLiveSwitchDynamic.

◆ maxRetries

- (int) maxRetries

Gets the maximum number of retries allowed.

◆ method

- (FMLiveSwitchHttpMethod) method

Gets the HTTP method.

◆ onRequestCreated

- (FMLiveSwitchAction1<FMLiveSwitchHttpRequestCreatedArgs*>*) onRequestCreated

Gets the callback to invoke once the outgoing HTTP request is created.

See FMLiveSwitchHttpRequestCreatedArgs for callback argument details.

◆ onResponseReceived

- (FMLiveSwitchAction1<FMLiveSwitchHttpResponseReceivedArgs*>*) onResponseReceived

Gets the callback to invoke once the incoming HTTP response has been received.

See FMLiveSwitchHttpResponseReceivedArgs for callback argument details.

◆ sender

- (id) sender

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

◆ setBinaryContent:

- (void) setBinaryContent: (NSMutableData *)  value

Sets the binary content to transfer over HTTP.

Overrides textContent.

◆ setHeaders:

- (void) setHeaders: (FMLiveSwitchNameValueCollection *)  value

Sets the headers to transfer over HTTP.

◆ setMaxRetries:

- (void) setMaxRetries: (int)  value

Sets the maximum number of retries allowed.

◆ setMethod:

- (void) setMethod: (FMLiveSwitchHttpMethod)  value

Sets the HTTP method.

◆ setOnRequestCreated:

- (void) setOnRequestCreated: (FMLiveSwitchAction1< FMLiveSwitchHttpRequestCreatedArgs * > *)  value

Sets the callback to invoke once the outgoing HTTP request is created.

See FMLiveSwitchHttpRequestCreatedArgs for callback argument details.

◆ setOnRequestCreatedBlock

- (FMLiveSwitchHttpRequestCreatedArgs*) setOnRequestCreatedBlock

Sets the callback to invoke once the outgoing HTTP request is created.

See FMLiveSwitchHttpRequestCreatedArgs for callback argument details.

◆ setOnRequestCreatedBlock:

- (void) setOnRequestCreatedBlock: (void(^)(FMLiveSwitchHttpRequestCreatedArgs *))  valueBlock

Sets the callback to invoke once the outgoing HTTP request is created.

See FMLiveSwitchHttpRequestCreatedArgs for callback argument details.

◆ setOnResponseReceived:

- (void) setOnResponseReceived: (FMLiveSwitchAction1< FMLiveSwitchHttpResponseReceivedArgs * > *)  value

Sets the callback to invoke once the incoming HTTP response has been received.

See FMLiveSwitchHttpResponseReceivedArgs for callback argument details.

◆ setOnResponseReceivedBlock

- (FMLiveSwitchHttpResponseReceivedArgs*) setOnResponseReceivedBlock

Sets the callback to invoke once the incoming HTTP response has been received.

See FMLiveSwitchHttpResponseReceivedArgs for callback argument details.

◆ setOnResponseReceivedBlock:

- (void) setOnResponseReceivedBlock: (void(^)(FMLiveSwitchHttpResponseReceivedArgs *))  valueBlock

Sets the callback to invoke once the incoming HTTP response has been received.

See FMLiveSwitchHttpResponseReceivedArgs for callback argument details.

◆ setSender:

- (void) setSender: (id value

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

◆ setTextContent:

- (void) setTextContent: (NSString *)  value

Sets the text content to transfer over HTTP.

◆ setTimeout:

- (void) setTimeout: (int)  value

Sets the number of milliseconds to wait before timing out the HTTP transfer.

Defaults to 15000 ms (15 seconds).

◆ setUrl:

- (void) setUrl: (NSString *)  value

Sets the target URL for the HTTP request.

◆ textContent

- (NSString*) textContent

Gets the text content to transfer over HTTP.

◆ timeout

- (int) timeout

Gets the number of milliseconds to wait before timing out the HTTP transfer.

Defaults to 15000 ms (15 seconds).

◆ url

- (NSString*) url

Gets the target URL for the HTTP request.