FMWebSyncClient Class Reference

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

- (FMWebSyncClient *)bindWithBindArgs:(FMWebSyncBindArgs *)bindArgs

Parameters

`name="bindArgs">The`	bind arguments. See for details. The client.

Discussion

Binds the client to a public or private data record so it is visible to other clients or just to the server.

When the bind completes successfully, the OnSuccess callback will be invoked, passing in the bound record(s), including any modifications made on the server.

Declared In

FMWebSync.h

`– bindWithArgs:`

Binds the client to a public or private data record so it is visible to other clients or just to the server.

When the bind completes successfully, the OnSuccess callback will be invoked, passing in the bound record(s), including any modifications made on the server.

- (FMWebSyncClient *)bindWithArgs:(FMWebSyncBindArgs *)bindArgs

Parameters

`name="bindArgs">The`	bind arguments. See for details. The client.

Discussion

Binds the client to a public or private data record so it is visible to other clients or just to the server.

When the bind completes successfully, the OnSuccess callback will be invoked, passing in the bound record(s), including any modifications made on the server.

Declared In

FMWebSync.h

`– clientId`

Gets the server-generated WebSync client ID. This value is only set if the client is connected, so reference it only after successfully connecting the client.

- (FMGuid *)clientId

Discussion

Gets the server-generated WebSync client ID. This value is only set if the client is connected, so reference it only after successfully connecting the client.

Declared In

FMWebSync.h

`+ clientWithRequestUrl:`

Initializes a new instance of the class.

+ (FMWebSyncClient *)clientWithRequestUrl:(NSString *)requestUrl

Parameters

`name="requestUrl">The`	absolute URL of the WebSync server request handler.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

`+ clientWithRequestUrl:streamRequestUrl:`

Initializes a new instance of the class.

+ (FMWebSyncClient *)clientWithRequestUrl:(NSString *)requestUrl streamRequestUrl:(NSString *)streamRequestUrl

Parameters

`name="streamRequestUrl">The`	absolute URL of the WebSync server request handler for streaming requests.
`name="requestUrl">The`	absolute URL of the WebSync server request handler for non-streaming requests.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

`– connect`

Sets up and maintains a streaming connection to the server using default values.

While this method will typically run asychronously, the WebSync client is designed to be used without (much) consideration for its asynchronous nature. To that end, any calls to methods that require an active connection, like bind, subscribe, and publish, will be queued automatically and executed once this method has completed successfully. The client.

- (FMWebSyncClient *)connect

Discussion

Sets up and maintains a streaming connection to the server using default values.

While this method will typically run asychronously, the WebSync client is designed to be used without (much) consideration for its asynchronous nature. To that end, any calls to methods that require an active connection, like bind, subscribe, and publish, will be queued automatically and executed once this method has completed successfully. The client.

Declared In

FMWebSync.h

`– connectWithConnectArgs:`

Sets up and maintains a streaming connection to the server.

While this method will typically run asychronously, the WebSync client is designed to be used without (much) consideration for its asynchronous nature. To that end, any calls to methods that require an active connection, like bind, subscribe, and publish, will be queued automatically and executed once this method has completed successfully.

- (FMWebSyncClient *)connectWithConnectArgs:(FMWebSyncConnectArgs *)connectArgs

Parameters

`name="connectArgs">The`	connect arguments. See for details. The client.

Discussion

Sets up and maintains a streaming connection to the server.

While this method will typically run asychronously, the WebSync client is designed to be used without (much) consideration for its asynchronous nature. To that end, any calls to methods that require an active connection, like bind, subscribe, and publish, will be queued automatically and executed once this method has completed successfully.

Declared In

FMWebSync.h

`– connectWithArgs:`

Sets up and maintains a streaming connection to the server.

While this method will typically run asychronously, the WebSync client is designed to be used without (much) consideration for its asynchronous nature. To that end, any calls to methods that require an active connection, like bind, subscribe, and publish, will be queued automatically and executed once this method has completed successfully.

- (FMWebSyncClient *)connectWithArgs:(FMWebSyncConnectArgs *)connectArgs

Parameters

`name="connectArgs">The`	connect arguments. See for details. The client.

Discussion

Sets up and maintains a streaming connection to the server.

While this method will typically run asychronously, the WebSync client is designed to be used without (much) consideration for its asynchronous nature. To that end, any calls to methods that require an active connection, like bind, subscribe, and publish, will be queued automatically and executed once this method has completed successfully.

Declared In

FMWebSync.h

`– disableWebSockets`

Gets whether to disable WebSocket protocol support and use long-polling, even if the server is capable of accepting WebSocket requests.

- (bool)disableWebSockets

Discussion

Gets whether to disable WebSocket protocol support and use long-polling, even if the server is capable of accepting WebSocket requests.

Declared In

FMWebSync.h

`– disconnect`

Takes down a streaming connection to the server and unsubscribes the client using default values.

After the disconnect completes successfully, any further calls to methods that require an active connection, like bind, subscribe, and publish, will be queued automatically and executed only if/when the client reconnects. The client.

`name="channel">The`	channel over which the messages are being received. The callback invoked when a message is received, if a callback is set; otherwise null.

Discussion

Gets the callback invoked whenever messages are received on the specified channel.

Declared In

FMWebSync.h

`– getCustomOnReceiveWithTagWithChannel:tag:`

Gets the callback invoked whenever messages are received on the specified channel. The tag denotes a specific callback.

- (FMCallback *)getCustomOnReceiveWithTagWithChannel:(NSString *)channel tag:(NSString *)tag

Parameters

`name="channel">The`	channel over which the messages are being received.
`name="tag">The`	identifier for the callback. The callback invoked when a message is received, if a callback is set; otherwise null.

Discussion

Gets the callback invoked whenever messages are received on the specified channel. The tag denotes a specific callback.

Declared In

FMWebSync.h

`– getSubscribedChannels`

Gets a list of all the channels to which the client is currently subscribed.

A list of all the channels to which the client is currently subscribed

- (NSMutableArray *)getSubscribedChannels

Discussion

Gets a list of all the channels to which the client is currently subscribed.

A list of all the channels to which the client is currently subscribed

Declared In

FMWebSync.h

`– getSubscribedChannelsWithTag:`

Gets a list of all the channels to which the client is currently subscribed.

- (NSMutableArray *)getSubscribedChannelsWithTag:(NSString *)tag

Parameters

`name="tag">The`	subscription tag identifier. A list of all the channels to which the client is currently subscribed

Discussion

Gets a list of all the channels to which the client is currently subscribed.

Declared In

FMWebSync.h

`– inBatch`

Gets whether or not requests are currently being batched.

true if requests are being batched; otherwise false.

- (bool)inBatch

Discussion

Gets whether or not requests are currently being batched.

true if requests are being batched; otherwise false.

Declared In

FMWebSync.h

`– initWithRequestUrl:`

Initializes a new instance of the class.

- (id)initWithRequestUrl:(NSString *)requestUrl

Parameters

`name="requestUrl">The`	absolute URL of the WebSync server request handler.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

`– initWithRequestUrl:streamRequestUrl:`

Initializes a new instance of the class.

- (id)initWithRequestUrl:(NSString *)requestUrl streamRequestUrl:(NSString *)streamRequestUrl

Parameters

`name="streamRequestUrl">The`	absolute URL of the WebSync server request handler for streaming requests.
`name="requestUrl">The`	absolute URL of the WebSync server request handler for non-streaming requests.

- (FMWebSyncClient *)notifyWithNotifyArgs:(FMWebSyncNotifyArgs *)notifyArgs

Parameters

`name="notifyArgs">The`	notify arguments. See for more details. The client.

Discussion

Sends data to a specified client ID.

When the notify completes successfully, the OnSuccess callback will be invoked, passing in the channel and published data, including any modifications made on the server.

Declared In

FMWebSync.h

`– notifyWithArgs:`

Sends data to a specified client ID.

When the notify completes successfully, the OnSuccess callback will be invoked, passing in the channel and published data, including any modifications made on the server.

- (FMWebSyncClient *)notifyWithArgs:(FMWebSyncNotifyArgs *)notifyArgs

Parameters

`name="notifyArgs">The`	notify arguments. See for more details. The client.

Discussion

Sends data to a specified client ID.

When the notify completes successfully, the OnSuccess callback will be invoked, passing in the channel and published data, including any modifications made on the server.

Declared In

FMWebSync.h

`– publishWithPublishArgs:`

Sends data to a specified channel.

When the publish completes successfully, the OnSuccess callback will be invoked, passing in the channel and published data, including any modifications made on the server.

- (FMWebSyncClient *)publishWithPublishArgs:(FMWebSyncPublishArgs *)publishArgs

Parameters

`name="publishArgs">The`	publish arguments. See for more details. The client.

Discussion

Sends data to a specified channel.

When the publish completes successfully, the OnSuccess callback will be invoked, passing in the channel and published data, including any modifications made on the server.

Declared In

FMWebSync.h

`– publishWithArgs:`

Sends data to a specified channel.

When the publish completes successfully, the OnSuccess callback will be invoked, passing in the channel and published data, including any modifications made on the server.

- (FMWebSyncClient *)publishWithArgs:(FMWebSyncPublishArgs *)publishArgs

Parameters

`name="publishArgs">The`	publish arguments. See for more details. The client.

Discussion

+ (void)removeOnBindEndWithValue:(FMCallback *)value

Discussion

Removes a handler that is raised after a bind ends. This event is designed to support extensions by allowing modifications to be applied to the client after processing.