FMWebSyncSubscribedClient Class Reference

Inherits from FMSerializable : NSObject
Declared in FMWebSync.h

Overview

Details about the subscribed client.

– boundRecords

Gets the subscribed client’s bound records.

- (NSMutableDictionary *)boundRecords

Discussion

Gets the subscribed client’s bound records.

Declared In

FMWebSync.h

– clientId

Gets the subscribed client’s ID.

- (FMGuid *)clientId

Discussion

Gets the subscribed client’s ID.

Declared In

FMWebSync.h

+ fromJsonMultipleWithSubscribedClientsJson:

Deserializes a JSON-formatted array of subscribed clients.

+ (NSMutableArray *)fromJsonMultipleWithSubscribedClientsJson:(NSString *)subscribedClientsJson

Parameters

name="subscribedClientsJson">The

JSON-formatted array of subscribed clients to deserialize. The array of subscribed clients.

Discussion

Deserializes a JSON-formatted array of subscribed clients.

Declared In

FMWebSync.h

+ fromJsonWithSubscribedClientJson:

Deserializes a JSON-formatted subscribed client.

+ (FMWebSyncSubscribedClient *)fromJsonWithSubscribedClientJson:(NSString *)subscribedClientJson

Parameters

name="subscribedClientJson">The

JSON-formatted subscribed client to deserialize. The subscribed client.

Discussion

Deserializes a JSON-formatted subscribed client.

Declared In

FMWebSync.h

– getBoundRecordValueJsonWithKey:

Gets the JSON value of a record bound to the subscribed client.

- (NSString *)getBoundRecordValueJsonWithKey:(NSString *)key

Parameters

name="key">The

record key. The JSON value of the record, if it exists, or null.

Discussion

Gets the JSON value of a record bound to the subscribed client.

Declared In

FMWebSync.h

– init

Initializes a new instance of the class.

- (id)init

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

– initWithClientId:boundRecords:

Initializes a new instance of the class.

- (id)initWithClientId:(FMGuid *)clientId boundRecords:(NSMutableDictionary *)boundRecords

Parameters

name="boundRecords">The

records bound to the client.
name="clientId">The

subscribed client’s ID.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

– setBoundRecords:

Sets the subscribed client’s bound records.

- (void)setBoundRecords:(NSMutableDictionary *)value

Discussion

Sets the subscribed client’s bound records.

Declared In

FMWebSync.h

– setClientId:

Sets the subscribed client’s ID.

- (void)setClientId:(FMGuid *)value

Discussion

Sets the subscribed client’s ID.

Declared In

FMWebSync.h

+ subscribedClient

Initializes a new instance of the class.

+ (FMWebSyncSubscribedClient *)subscribedClient

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

+ subscribedClientWithClientId:boundRecords:

Initializes a new instance of the class.

+ (FMWebSyncSubscribedClient *)subscribedClientWithClientId:(FMGuid *)clientId boundRecords:(NSMutableDictionary *)boundRecords

Parameters

name="boundRecords">The

records bound to the client.
name="clientId">The

subscribed client’s ID.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

+ subscribedClientWithId:boundRecords:

Initializes a new instance of the class.

+ (FMWebSyncSubscribedClient *)subscribedClientWithId:(FMGuid *)clientId boundRecords:(NSMutableDictionary *)boundRecords

Parameters

name="boundRecords">The

records bound to the client.
name="clientId">The

subscribed client’s ID.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

– toJson

Serializes this instance to JSON. The JSON-formatted subscribed client.

- (NSString *)toJson

Discussion

Serializes this instance to JSON. The JSON-formatted subscribed client.

Declared In

FMWebSync.h

+ toJsonMultipleWithSubscribedClients:

Serializes an array of subscribed clients to JSON.

+ (NSString *)toJsonMultipleWithSubscribedClients:(NSMutableArray *)subscribedClients

Parameters

name="subscribedClients">The

array of subscribed clients to serialize. The JSON-formatted array of subscribed clients.

Discussion

Serializes an array of subscribed clients to JSON.

Declared In

FMWebSync.h

+ toJsonWithSubscribedClient:

Serializes a subscribed client to JSON.

+ (NSString *)toJsonWithSubscribedClient:(FMWebSyncSubscribedClient *)subscribedClient

Parameters

name="subscribedClient">The

subscribed client to serialize. The JSON-formatted subscribed client.

Discussion

Serializes a subscribed client to JSON.

Declared In

FMWebSync.h