FMWebSyncMessageRequestArgs Class Reference

Inherits from FMDynamic : FMSerializable : NSObject
Declared in FMWebSync.h

Overview

Arguments for sending a message request.

– headers

Gets the headers for the request.

- (FMNameValueCollection *)headers

Discussion

Gets the headers for the request.

Declared In

FMWebSync.h

– initWithHeaders:

Initializes a new instance of the class with default values.

- (id)initWithHeaders:(FMNameValueCollection *)headers

Discussion

Initializes a new instance of the class with default values.

Declared In

FMWebSync.h

– isBinary

Gets whether or not each message in the batch is in binary format and can be tranferred as such.

- (bool)isBinary

Discussion

Gets whether or not each message in the batch is in binary format and can be tranferred as such.

Declared In

FMWebSync.h

+ messageRequestArgsWithHeaders:

Initializes a new instance of the class with default values.

+ (FMWebSyncMessageRequestArgs *)messageRequestArgsWithHeaders:(FMNameValueCollection *)headers

Discussion

Initializes a new instance of the class with default values.

Declared In

FMWebSync.h

– messages

Gets the messages to transfer.

- (NSMutableArray *)messages

Discussion

Gets the messages to transfer.

Declared In

FMWebSync.h

– onHttpRequestCreated

Gets the callback to invoke whenever an underlying HTTP request has been created and is about to be transferred to the server. This is a good place to add headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

- (FMCallback *)onHttpRequestCreated

Discussion

Gets the callback to invoke whenever an underlying HTTP request has been created and is about to be transferred to the server. This is a good place to add headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

Declared In

FMWebSync.h

– onHttpResponseReceived

Gets the callback to invoke whenever an underlying HTTP response has been received and is about to be processed by the client. This is a good place to read headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

- (FMCallback *)onHttpResponseReceived

Discussion

Gets the callback to invoke whenever an underlying HTTP response has been received and is about to be processed by the client. This is a good place to read headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

Declared In

FMWebSync.h

– onRequestCreated

Gets the callback to invoke whenever a new request is created and about to be transferred to the server. This is a good place to read or modify outgoing messages.

- (FMCallback *)onRequestCreated

Discussion

Gets the callback to invoke whenever a new request is created and about to be transferred to the server. This is a good place to read or modify outgoing messages.

Declared In

FMWebSync.h

– onResponseReceived

Gets the callback to invoke whenever a new response is received and about to be processed by the client. This is a good place to read or modify incoming messages.

- (FMCallback *)onResponseReceived

Discussion

Gets the callback to invoke whenever a new response is received and about to be processed by the client. This is a good place to read or modify incoming messages.

Declared In

FMWebSync.h

– sender

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

- (NSObject *)sender

Discussion

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

Declared In

FMWebSync.h

– setHeaders:

Sets the headers for the request.

- (void)setHeaders:(FMNameValueCollection *)value

Discussion

Sets the headers for the request.

Declared In

FMWebSync.h

– setMessages:

Sets the messages to transfer.

- (void)setMessages:(NSMutableArray *)value

Discussion

Sets the messages to transfer.

Declared In

FMWebSync.h

– setOnHttpRequestCreated:

Sets the callback to invoke whenever an underlying HTTP request has been created and is about to be transferred to the server. This is a good place to add headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

- (void)setOnHttpRequestCreated:(FMCallback *)value

Discussion

Sets the callback to invoke whenever an underlying HTTP request has been created and is about to be transferred to the server. This is a good place to add headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

Declared In

FMWebSync.h

– setOnHttpRequestCreatedBlock:

Sets the callback to invoke whenever an underlying HTTP request has been created and is about to be transferred to the server. This is a good place to add headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

- (void)setOnHttpRequestCreatedBlock:(void ( ^ ) ( FMHttpRequestCreatedArgs *))valueBlock

Discussion

Sets the callback to invoke whenever an underlying HTTP request has been created and is about to be transferred to the server. This is a good place to add headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

Declared In

FMWebSync.h

– setOnHttpResponseReceived:

Sets the callback to invoke whenever an underlying HTTP response has been received and is about to be processed by the client. This is a good place to read headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

- (void)setOnHttpResponseReceived:(FMCallback *)value

Discussion

Sets the callback to invoke whenever an underlying HTTP response has been received and is about to be processed by the client. This is a good place to read headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

Declared In

FMWebSync.h

– setOnHttpResponseReceivedBlock:

Sets the callback to invoke whenever an underlying HTTP response has been received and is about to be processed by the client. This is a good place to read headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

- (void)setOnHttpResponseReceivedBlock:(void ( ^ ) ( FMHttpResponseReceivedArgs *))valueBlock

Discussion

Sets the callback to invoke whenever an underlying HTTP response has been received and is about to be processed by the client. This is a good place to read headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

Declared In

FMWebSync.h

– setOnRequestCreated:

Sets the callback to invoke whenever a new request is created and about to be transferred to the server. This is a good place to read or modify outgoing messages.

- (void)setOnRequestCreated:(FMCallback *)value

Discussion

Sets the callback to invoke whenever a new request is created and about to be transferred to the server. This is a good place to read or modify outgoing messages.

Declared In

FMWebSync.h

– setOnRequestCreatedBlock:

Sets the callback to invoke whenever a new request is created and about to be transferred to the server. This is a good place to read or modify outgoing messages.

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

Discussion

Sets the callback to invoke whenever a new request is created and about to be transferred to the server. This is a good place to read or modify outgoing messages.

Declared In

FMWebSync.h

– setOnResponseReceived:

Sets the callback to invoke whenever a new response is received and about to be processed by the client. This is a good place to read or modify incoming messages.

- (void)setOnResponseReceived:(FMCallback *)value

Discussion

Sets the callback to invoke whenever a new response is received and about to be processed by the client. This is a good place to read or modify incoming messages.

Declared In

FMWebSync.h

– setOnResponseReceivedBlock:

Sets the callback to invoke whenever a new response is received and about to be processed by the client. This is a good place to read or modify incoming messages.

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

Discussion

Sets the callback to invoke whenever a new response is received and about to be processed by the client. This is a good place to read or modify incoming messages.

Declared In

FMWebSync.h

– setSender:

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

- (void)setSender:(NSObject *)value

Discussion

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

Declared In

FMWebSync.h

– setTimeout:

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

- (void)setTimeout:(int)value

Discussion

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

Declared In

FMWebSync.h

– setUrl:

Sets the target URL for the request.

- (void)setUrl:(NSString *)value

Discussion

Sets the target URL for the request.

Declared In

FMWebSync.h

– timeout

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

- (int)timeout

Discussion

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

Declared In

FMWebSync.h

– url

Gets the target URL for the request.

- (NSString *)url

Discussion

Gets the target URL for the request.

Declared In

FMWebSync.h