FMWebSyncPublishArgs Class Reference

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

Overview

Arguments for client publish requests.

– channel

Gets the channel to which the data should be sent. Must start with a forward slash (/).

- (NSString *)channel

Discussion

Gets the channel to which the data should be sent. Must start with a forward slash (/).

Declared In

FMWebSync.h

– dataBytes

Gets the data to send in binary format. (Overrides .)

- (NSMutableData *)dataBytes

Discussion

Gets the data to send in binary format. (Overrides .)

Declared In

FMWebSync.h

– dataJson

Gets the data to send in JSON format. (Overrides .)

- (NSString *)dataJson

Discussion

Gets the data to send in JSON format. (Overrides .)

Declared In

FMWebSync.h

– initWithChannel:dataBytes:

Initializes a new instance of the class.

- (id)initWithChannel:(NSString *)channel dataBytes:(NSMutableData *)dataBytes

Parameters

name="channel">The

channel to which the data should be sent.
name="dataBytes">The

data to send in binary format.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

– initWithChannel:dataBytes:tag:

Initializes a new instance of the class.

- (id)initWithChannel:(NSString *)channel dataBytes:(NSMutableData *)dataBytes tag:(NSString *)tag

Parameters

name="channel">The

channel to which the data should be sent.
name="dataBytes">The

data to send in binary format.
name="tag">The

tag that identifies the contents of the payload.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

– initWithChannel:dataJson:

Initializes a new instance of the class.

- (id)initWithChannel:(NSString *)channel dataJson:(NSString *)dataJson

Parameters

name="channel">The

channel to which the data should be sent.
name="dataJson">The

data to send in JSON format.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

– initWithChannel:dataJson:tag:

Initializes a new instance of the class.

- (id)initWithChannel:(NSString *)channel dataJson:(NSString *)dataJson tag:(NSString *)tag

Parameters

name="channel">The

channel to which the data should be sent.
name="dataJson">The

data to send in JSON format.
name="tag">The

tag that identifies the contents of the payload.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

– isBinary

Gets whether or not the data is binary.

- (bool)isBinary

Discussion

Gets whether or not the data is binary.

Declared In

FMWebSync.h

– onComplete

Gets the callback to invoke after or .

- (FMCallback *)onComplete

Discussion

Gets the callback to invoke after or .

Declared In

FMWebSync.h

– onFailure

Gets the callback to invoke if the request fails.

- (FMCallback *)onFailure

Discussion

Gets the callback to invoke if the request fails.

Declared In

FMWebSync.h

– onSuccess

Gets the callback to invoke if the request succeeds.

- (FMCallback *)onSuccess

Discussion

Gets the callback to invoke if the request succeeds.

Declared In

FMWebSync.h

+ publishArgsWithChannel:dataBytes:

Initializes a new instance of the class.

+ (FMWebSyncPublishArgs *)publishArgsWithChannel:(NSString *)channel dataBytes:(NSMutableData *)dataBytes

Parameters

name="channel">The

channel to which the data should be sent.
name="dataBytes">The

data to send in binary format.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

+ publishArgsWithChannel:dataBytes:tag:

Initializes a new instance of the class.

+ (FMWebSyncPublishArgs *)publishArgsWithChannel:(NSString *)channel dataBytes:(NSMutableData *)dataBytes tag:(NSString *)tag

Parameters

name="channel">The

channel to which the data should be sent.
name="dataBytes">The

data to send in binary format.
name="tag">The

tag that identifies the contents of the payload.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

+ publishArgsWithChannel:dataJson:

Initializes a new instance of the class.

+ (FMWebSyncPublishArgs *)publishArgsWithChannel:(NSString *)channel dataJson:(NSString *)dataJson

Parameters

name="channel">The

channel to which the data should be sent.
name="dataJson">The

data to send in JSON format.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

+ publishArgsWithChannel:dataJson:tag:

Initializes a new instance of the class.

+ (FMWebSyncPublishArgs *)publishArgsWithChannel:(NSString *)channel dataJson:(NSString *)dataJson tag:(NSString *)tag

Parameters

name="channel">The

channel to which the data should be sent.
name="dataJson">The

data to send in JSON format.
name="tag">The

tag that identifies the contents of the payload.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

– setChannel:

Sets the channel to which the data should be sent. Must start with a forward slash (/).

- (void)setChannel:(NSString *)value

Discussion

Sets the channel to which the data should be sent. Must start with a forward slash (/).

Declared In

FMWebSync.h

– setDataBytes:

Sets the data to send in binary format. (Overrides .)

- (void)setDataBytes:(NSMutableData *)value

Discussion

Sets the data to send in binary format. (Overrides .)

Declared In

FMWebSync.h

– setDataJson:

Sets the data to send in JSON format. (Overrides .)

- (void)setDataJson:(NSString *)value

Discussion

Sets the data to send in JSON format. (Overrides .)

Declared In

FMWebSync.h

– setOnComplete:

Sets the callback to invoke after or .

- (void)setOnComplete:(FMCallback *)value

Discussion

Sets the callback to invoke after or .

Declared In

FMWebSync.h

– setOnCompleteBlock:

Sets the callback to invoke after or .

- (void)setOnCompleteBlock:(void ( ^ ) ( FMWebSyncPublishCompleteArgs *))valueBlock

Discussion

Sets the callback to invoke after or .

Declared In

FMWebSync.h

– setOnFailure:

Sets the callback to invoke if the request fails.

- (void)setOnFailure:(FMCallback *)value

Discussion

Sets the callback to invoke if the request fails.

Declared In

FMWebSync.h

– setOnFailureBlock:

Sets the callback to invoke if the request fails.

- (void)setOnFailureBlock:(void ( ^ ) ( FMWebSyncPublishFailureArgs *))valueBlock

Discussion

Sets the callback to invoke if the request fails.

Declared In

FMWebSync.h

– setOnSuccess:

Sets the callback to invoke if the request succeeds.

- (void)setOnSuccess:(FMCallback *)value

Discussion

Sets the callback to invoke if the request succeeds.

Declared In

FMWebSync.h

– setOnSuccessBlock:

Sets the callback to invoke if the request succeeds.

- (void)setOnSuccessBlock:(void ( ^ ) ( FMWebSyncPublishSuccessArgs *))valueBlock

Discussion

Sets the callback to invoke if the request succeeds.

Declared In

FMWebSync.h

– setTag:

Sets the tag that identifies the contents of the payload.

- (void)setTag:(NSString *)value

Discussion

Sets the tag that identifies the contents of the payload.

Declared In

FMWebSync.h

– tag

Gets the tag that identifies the contents of the payload.

- (NSString *)tag

Discussion

Gets the tag that identifies the contents of the payload.

Declared In

FMWebSync.h