FMIceLinkHttpTransfer Class Reference

Inherits from NSObject
Declared in FMIceLinkHttpTransfer.h
FMIceLinkHttpTransfer.m

Overview

Base class that defines methods for transferring content over HTTP.

+ addOnSendFinish:

Adds a handler that is raised before an HTTP request is sent.

The FMIceLinkHttpSendFinishArgs associated with the event.

+ (void)addOnSendFinish:(FMIceLinkAction1<FMIceLinkHttpSendFinishArgs*> *)value

Discussion

Adds a handler that is raised before an HTTP request is sent.

The FMIceLinkHttpSendFinishArgs associated with the event.

Declared In

FMIceLinkHttpTransfer.h

+ addOnSendFinishWithBlock

Adds a handler that is raised before an HTTP request is sent.

The FMIceLinkHttpSendFinishArgs associated with the event.

+ (void ( ^ ) ( void ( ^ ) ( FMIceLinkHttpSendFinishArgs *) ))addOnSendFinishWithBlock

Discussion

Adds a handler that is raised before an HTTP request is sent.

The FMIceLinkHttpSendFinishArgs associated with the event.

Declared In

FMIceLinkHttpTransfer.h

+ addOnSendFinishWithBlock:

Adds a handler that is raised before an HTTP request is sent.

The FMIceLinkHttpSendFinishArgs associated with the event.

+ (void)addOnSendFinishWithBlock:(void ( ^ ) ( FMIceLinkHttpSendFinishArgs *))valueBlock

Discussion

Adds a handler that is raised before an HTTP request is sent.

The FMIceLinkHttpSendFinishArgs associated with the event.

Declared In

FMIceLinkHttpTransfer.h

+ addOnSendStart:

Adds a handler that is raised before an HTTP request is sent.

The FMIceLinkHttpSendStartArgs associated with the event.

+ (void)addOnSendStart:(FMIceLinkAction1<FMIceLinkHttpSendStartArgs*> *)value

Discussion

Adds a handler that is raised before an HTTP request is sent.

The FMIceLinkHttpSendStartArgs associated with the event.

Declared In

FMIceLinkHttpTransfer.h

+ addOnSendStartWithBlock

Adds a handler that is raised before an HTTP request is sent.

The FMIceLinkHttpSendStartArgs associated with the event.

+ (void ( ^ ) ( void ( ^ ) ( FMIceLinkHttpSendStartArgs *) ))addOnSendStartWithBlock

Discussion

Adds a handler that is raised before an HTTP request is sent.

The FMIceLinkHttpSendStartArgs associated with the event.

Declared In

FMIceLinkHttpTransfer.h

+ addOnSendStartWithBlock:

Adds a handler that is raised before an HTTP request is sent.

The FMIceLinkHttpSendStartArgs associated with the event.

+ (void)addOnSendStartWithBlock:(void ( ^ ) ( FMIceLinkHttpSendStartArgs *))valueBlock

Discussion

Adds a handler that is raised before an HTTP request is sent.

The FMIceLinkHttpSendStartArgs associated with the event.

Declared In

FMIceLinkHttpTransfer.h

+ addQueryToUrl:key:

Escapes and adds a query parameter as a key/empty-value pair to a URL.
+ (NSString *)addQueryToUrl:(NSString *)url key:(NSString *)key

Parameters

url

The URL with the query to which the key/value should be added.
key

The key of the query parameter to add.

Return Value

The original URL with the query parameter added.

Discussion

Escapes and adds a query parameter as a key/empty-value pair to a URL.

Declared In

FMIceLinkHttpTransfer.h

+ addQueryToUrl:key:value:

Escapes and adds a query parameter as a key/value pair to a URL.
+ (NSString *)addQueryToUrl:(NSString *)url key:(NSString *)key value:(NSString *)value

Parameters

url

The URL with the query to which the key/value should be added.
key

The key of the query parameter to add.
value

The value of the query parameter to add.

Return Value

The original URL with the query parameter added.

Discussion

Escapes and adds a query parameter as a key/value pair to a URL.

Declared In

FMIceLinkHttpTransfer.h

+ getRandomWildcardCharacter

Gets a random wildcard character.
+ (NSString *)getRandomWildcardCharacter

Return Value

A random wildcard character.

Discussion

Gets a random wildcard character.

Declared In

FMIceLinkHttpTransfer.h

+ removeOnSendFinish:

Removes a handler that is raised before an HTTP request is sent.

The FMIceLinkHttpSendFinishArgs associated with the event.

+ (void)removeOnSendFinish:(FMIceLinkAction1<FMIceLinkHttpSendFinishArgs*> *)value

Discussion

Removes a handler that is raised before an HTTP request is sent.

The FMIceLinkHttpSendFinishArgs associated with the event.

Declared In

FMIceLinkHttpTransfer.h

+ removeOnSendStart:

Removes a handler that is raised before an HTTP request is sent.

The FMIceLinkHttpSendStartArgs associated with the event.

+ (void)removeOnSendStart:(FMIceLinkAction1<FMIceLinkHttpSendStartArgs*> *)value

Discussion

Removes a handler that is raised before an HTTP request is sent.

The FMIceLinkHttpSendStartArgs associated with the event.

Declared In

FMIceLinkHttpTransfer.h

+ replaceWildcardsWithUrl:

Replaces asterisks in URLs with characters from WildcardCharacters.
+ (NSString *)replaceWildcardsWithUrl:(NSString *)url

Parameters

url

The URL with asterisks.

Discussion

Replaces asterisks in URLs with characters from WildcardCharacters.

Declared In

FMIceLinkHttpTransfer.h

– sendAsyncWithRequestArgs:callback:

Sends a request asynchronously.
- (void)sendAsyncWithRequestArgs:(FMIceLinkHttpRequestArgs *)requestArgs callback:(FMIceLinkAction1<FMIceLinkHttpResponseArgs*> *)callback

Parameters

requestArgs

The request parameters.
callback

The callback to execute with the resulting response.

Discussion

Sends a request asynchronously.

Declared In

FMIceLinkHttpTransfer.h

– sendAsyncWithRequestArgs:callbackBlock:

Sends a request asynchronously.
- (void)sendAsyncWithRequestArgs:(FMIceLinkHttpRequestArgs *)requestArgs callbackBlock:(void ( ^ ) ( FMIceLinkHttpResponseArgs *))callbackBlock

Parameters

requestArgs

The request parameters.
callbackBlock

The callback to execute with the resulting response.

Discussion

Sends a request asynchronously.

Declared In

FMIceLinkHttpTransfer.h

– sendAsyncWithRequestArgsAndCallbackBlock

Sends a request asynchronously.

@inlineparam requestArgs The request parameters. @inlineparam callbackBlock The callback to execute with the resulting response.

- (void ( ^ ) ( FMIceLinkHttpRequestArgs *, void ( ^ ) ( FMIceLinkHttpResponseArgs *) ))sendAsyncWithRequestArgsAndCallbackBlock

Discussion

Sends a request asynchronously.

@inlineparam requestArgs The request parameters. @inlineparam callbackBlock The callback to execute with the resulting response.

Declared In

FMIceLinkHttpTransfer.h

– sendBinaryAsyncWithRequestArgs:callback:

Sends binary content asynchronously using the specified arguments.
- (void)sendBinaryAsyncWithRequestArgs:(FMIceLinkHttpRequestArgs *)requestArgs callback:(FMIceLinkAction1<FMIceLinkHttpResponseArgs*> *)callback

Parameters

requestArgs

The request arguments.
callback

The callback to execute on success or failure.

Discussion

Sends binary content asynchronously using the specified arguments.

Declared In

FMIceLinkHttpTransfer.h

– sendBinaryAsyncWithRequestArgs:callbackBlock:

Sends binary content asynchronously using the specified arguments.
- (void)sendBinaryAsyncWithRequestArgs:(FMIceLinkHttpRequestArgs *)requestArgs callbackBlock:(void ( ^ ) ( FMIceLinkHttpResponseArgs *))callbackBlock

Parameters

requestArgs

The request arguments.
callbackBlock

The callback to execute on success or failure.

Discussion

Sends binary content asynchronously using the specified arguments.

Declared In

FMIceLinkHttpTransfer.h

– sendBinaryAsyncWithRequestArgsAndCallbackBlock

Sends binary content asynchronously using the specified arguments.

@inlineparam requestArgs The request arguments. @inlineparam callbackBlock The callback to execute on success or failure.

- (void ( ^ ) ( FMIceLinkHttpRequestArgs *, void ( ^ ) ( FMIceLinkHttpResponseArgs *) ))sendBinaryAsyncWithRequestArgsAndCallbackBlock

Discussion

Sends binary content asynchronously using the specified arguments.

@inlineparam requestArgs The request arguments. @inlineparam callbackBlock The callback to execute on success or failure.

Declared In

FMIceLinkHttpTransfer.h

– sendBinaryWithRequestArgs:

Sends binary content synchronously using the specified arguments.
- (FMIceLinkHttpResponseArgs *)sendBinaryWithRequestArgs:(FMIceLinkHttpRequestArgs *)requestArgs

Parameters

requestArgs

The request arguments.

Return Value

The response arguments from the server.

Discussion

Sends binary content synchronously using the specified arguments.

Declared In

FMIceLinkHttpTransfer.h

– sendTextAsyncWithRequestArgs:callback:

Sends text content asynchronously using the specified arguments.
- (void)sendTextAsyncWithRequestArgs:(FMIceLinkHttpRequestArgs *)requestArgs callback:(FMIceLinkAction1<FMIceLinkHttpResponseArgs*> *)callback

Parameters

requestArgs

The request arguments.
callback

The callback to execute on success or failure.

Discussion

Sends text content asynchronously using the specified arguments.

Declared In

FMIceLinkHttpTransfer.h

– sendTextAsyncWithRequestArgs:callbackBlock:

Sends text content asynchronously using the specified arguments.
- (void)sendTextAsyncWithRequestArgs:(FMIceLinkHttpRequestArgs *)requestArgs callbackBlock:(void ( ^ ) ( FMIceLinkHttpResponseArgs *))callbackBlock

Parameters

requestArgs

The request arguments.
callbackBlock

The callback to execute on success or failure.

Discussion

Sends text content asynchronously using the specified arguments.

Declared In

FMIceLinkHttpTransfer.h

– sendTextAsyncWithRequestArgsAndCallbackBlock

Sends text content asynchronously using the specified arguments.

@inlineparam requestArgs The request arguments. @inlineparam callbackBlock The callback to execute on success or failure.

- (void ( ^ ) ( FMIceLinkHttpRequestArgs *, void ( ^ ) ( FMIceLinkHttpResponseArgs *) ))sendTextAsyncWithRequestArgsAndCallbackBlock

Discussion

Sends text content asynchronously using the specified arguments.

@inlineparam requestArgs The request arguments. @inlineparam callbackBlock The callback to execute on success or failure.

Declared In

FMIceLinkHttpTransfer.h

– sendTextWithRequestArgs:

Sends text content synchronously using the specified arguments.
- (FMIceLinkHttpResponseArgs *)sendTextWithRequestArgs:(FMIceLinkHttpRequestArgs *)requestArgs

Parameters

requestArgs

The request arguments.

Return Value

The response arguments from the server.

Discussion

Sends text content synchronously using the specified arguments.

Declared In

FMIceLinkHttpTransfer.h

– sendWithRequestArgs:

Sends a request synchronously.
- (FMIceLinkHttpResponseArgs *)sendWithRequestArgs:(FMIceLinkHttpRequestArgs *)requestArgs

Parameters

requestArgs

The request parameters.

Return Value

The resulting response.

Discussion

Sends a request synchronously.

Declared In

FMIceLinkHttpTransfer.h

+ setWildcardCharacters:

Sets the wildcard characters used to replace asterisks in ReplaceWildcards.
+ (void)setWildcardCharacters:(NSString *)value

Discussion

Sets the wildcard characters used to replace asterisks in ReplaceWildcards.

Declared In

FMIceLinkHttpTransfer.h

– shutdown

Releases any resources and shuts down.
- (void)shutdown

Discussion

Releases any resources and shuts down.

Declared In

FMIceLinkHttpTransfer.h

+ wildcardCharacters

Gets the wildcard characters used to replace asterisks in ReplaceWildcards.
+ (NSString *)wildcardCharacters

Discussion

Gets the wildcard characters used to replace asterisks in ReplaceWildcards.

Declared In

FMIceLinkHttpTransfer.h