FMWebSyncPublication Class Reference

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

Overview

The WebSync publication used for direct publishing.

– channel

Gets the channel the publisher is targeting.

- (NSString *)channel

Discussion

Gets the channel the publisher is targeting.

Declared In

FMWebSync.h

+ fromJsonMultipleWithPublicationsJson:

Deserializes a list of publications from JSON.

+ (NSMutableArray *)fromJsonMultipleWithPublicationsJson:(NSString *)publicationsJson

Parameters

name="publicationsJson">A

JSON string to deserialize. A deserialized list of publications.

Discussion

Deserializes a list of publications from JSON.

Declared In

FMWebSync.h

+ fromJsonWithPublicationJson:

Deserializes a publication from JSON.

+ (FMWebSyncPublication *)fromJsonWithPublicationJson:(NSString *)publicationJson

Parameters

name="publicationJson">A

JSON string to deserialize. A deserialized publication.

Discussion

Deserializes a publication from JSON.

Declared In

FMWebSync.h

+ fromMessagesWithMessages:

Converts a set of Publications from their Message formats.

+ (NSMutableArray *)fromMessagesWithMessages:(NSMutableArray *)messages

Parameters

name="messages">The

messages. The publications.

Discussion

Converts a set of Publications from their Message formats.

Declared In

FMWebSync.h

+ fromMessages:

Converts a set of Publications from their Message formats.

+ (NSMutableArray *)fromMessages:(NSMutableArray *)messages

Parameters

name="messages">The

messages. The publications.

Discussion

Converts a set of Publications from their Message formats.

Declared In

FMWebSync.h

+ fromMessageWithMessage:

Converts a Publication from its Message format.

+ (FMWebSyncPublication *)fromMessageWithMessage:(FMWebSyncMessage *)message

Parameters

name="message">The

message. The publication.

Discussion

Converts a Publication from its Message format.

Declared In

FMWebSync.h

+ fromMessage:

Converts a Publication from its Message format.

+ (FMWebSyncPublication *)fromMessage:(FMWebSyncMessage *)message

Parameters

name="message">The

message. The publication.

Discussion

Converts a Publication from its Message format.

Declared In

FMWebSync.h

– init

Creates a new publication.

- (id)init

Discussion

Creates a new publication.

Declared In

FMWebSync.h

– initWithChannel:

Creates a new publication with a channel.

- (id)initWithChannel:(NSString *)channel

Parameters

name="channel">The

channel to target.

Discussion

Creates a new publication with a channel.

Declared In

FMWebSync.h

– initWithChannel:dataBytes:

Creates a new publication with a channel, JSON data, and binary data.

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

Parameters

name="channel">The

channel to target.
name="dataBytes">The

data to send (in binary format).

Discussion

Creates a new publication with a channel, JSON data, and binary data.

Declared In

FMWebSync.h

– initWithChannel:dataBytes:tag:

Creates a new publication with a channel, JSON data, and binary data.

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

Parameters

name="channel">The

channel to target.
name="dataBytes">The

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

tag that identifies the contents of the payload.

Discussion

Creates a new publication with a channel, JSON data, and binary data.

Declared In

FMWebSync.h

– initWithChannel:dataJson:

Creates a new publication with a channel and JSON data.

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

Parameters

name="channel">The

channel to target.
name="dataJson">The

data to send (in JSON format).

Discussion

Creates a new publication with a channel and JSON data.

Declared In

FMWebSync.h

– initWithChannel:dataJson:tag:

Creates a new publication with a channel and JSON data.

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

Parameters

name="channel">The

channel to target.
name="dataJson">The

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

tag that identifies the contents of the payload.

Discussion

Creates a new publication with a channel and JSON data.

Declared In

FMWebSync.h

+ publication

Creates a new publication.

+ (FMWebSyncPublication *)publication

Discussion

Creates a new publication.

Declared In

FMWebSync.h

+ publicationWithChannel:

Creates a new publication with a channel.

+ (FMWebSyncPublication *)publicationWithChannel:(NSString *)channel

Parameters

name="channel">The

channel to target.

Discussion

Creates a new publication with a channel.

Declared In

FMWebSync.h

+ publicationWithChannel:dataBytes:

Creates a new publication with a channel, JSON data, and binary data.

+ (FMWebSyncPublication *)publicationWithChannel:(NSString *)channel dataBytes:(NSMutableData *)dataBytes

Parameters

name="channel">The

channel to target.
name="dataBytes">The

data to send (in binary format).

Discussion

Creates a new publication with a channel, JSON data, and binary data.

Declared In

FMWebSync.h

+ publicationWithChannel:dataBytes:tag:

Creates a new publication with a channel, JSON data, and binary data.

+ (FMWebSyncPublication *)publicationWithChannel:(NSString *)channel dataBytes:(NSMutableData *)dataBytes tag:(NSString *)tag

Parameters

name="channel">The

channel to target.
name="dataBytes">The

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

tag that identifies the contents of the payload.

Discussion

Creates a new publication with a channel, JSON data, and binary data.

Declared In

FMWebSync.h

+ publicationWithChannel:dataJson:

Creates a new publication with a channel and JSON data.

+ (FMWebSyncPublication *)publicationWithChannel:(NSString *)channel dataJson:(NSString *)dataJson

Parameters

name="channel">The

channel to target.
name="dataJson">The

data to send (in JSON format).

Discussion

Creates a new publication with a channel and JSON data.

Declared In

FMWebSync.h

+ publicationWithChannel:dataJson:tag:

Creates a new publication with a channel and JSON data.

+ (FMWebSyncPublication *)publicationWithChannel:(NSString *)channel dataJson:(NSString *)dataJson tag:(NSString *)tag

Parameters

name="channel">The

channel to target.
name="dataJson">The

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

tag that identifies the contents of the payload.

Discussion

Creates a new publication with a channel and JSON data.

Declared In

FMWebSync.h

– setChannel:

Sets the channel the publisher is targeting.

- (void)setChannel:(NSString *)value

Discussion

Sets the channel the publisher is targeting.

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

– toJson

Serializes the publication to JSON. The publication in JSON-serialized format.

- (NSString *)toJson

Discussion

Serializes the publication to JSON. The publication in JSON-serialized format.

Declared In

FMWebSync.h

+ toJsonMultipleWithPublications:

Serializes a list of publications to JSON.

+ (NSString *)toJsonMultipleWithPublications:(NSMutableArray *)publications

Parameters

name="publications">A

list of publications to serialize. A JSON-serialized array of publications.

Discussion

Serializes a list of publications to JSON.

Declared In

FMWebSync.h

+ toJsonWithPublication:

Serializes a publication to JSON.

+ (NSString *)toJsonWithPublication:(FMWebSyncPublication *)publication

Parameters

name="publication">A

publication to serialize. A JSON-serialized publication.

Discussion

Serializes a publication to JSON.

Declared In

FMWebSync.h

+ toMessagesWithPublications:

Converts a set of Publications to their Message formats.

+ (NSMutableArray *)toMessagesWithPublications:(NSMutableArray *)publications

Parameters

name="publications">The

publications. The messages.

Discussion

Converts a set of Publications to their Message formats.

Declared In

FMWebSync.h

+ toMessageWithPublication:

Converts a Publication to its Message format.

+ (FMWebSyncMessage *)toMessageWithPublication:(FMWebSyncPublication *)publication

Parameters

name="publication">The

publication. The message.

Discussion

Converts a Publication to its Message format.

Declared In

FMWebSync.h