FMWebSyncSubscribeArgs Class Reference

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

Overview

Arguments for client subscribe requests.

Other Methods

– autoResubscribe

Gets whether to call Subscribe with these args immediately after a reconnect following a stream failure. Generally, this should be null. The client will analyze the current context and set this flag as needed. However, it can be overridden for special cases. If set explicitly to false, then the client will assume that this call to Subscribe is being invoked from the OnSuccess callback of another WebSync method call, and therefore will be called again implicitly after a network reconnection. If set to true, then the client will assume this call to Subscribe is being invoked as a part of some external action and will force a Subscribe call using these arguments after a network reconnection. Defaults to null.

- (FMNullableBool *)autoResubscribe

Discussion

Gets whether to call Subscribe with these args immediately after a reconnect following a stream failure. Generally, this should be null. The client will analyze the current context and set this flag as needed. However, it can be overridden for special cases. If set explicitly to false, then the client will assume that this call to Subscribe is being invoked from the OnSuccess callback of another WebSync method call, and therefore will be called again implicitly after a network reconnection. If set to true, then the client will assume this call to Subscribe is being invoked as a part of some external action and will force a Subscribe call using these arguments after a network reconnection. Defaults to null.

Declared In

FMWebSync.h

– channel

Gets the channel to which the client should be subscribed. Must start with a forward slash (/). Overrides .

- (NSString *)channel

Discussion

Gets the channel to which the client should be subscribed. Must start with a forward slash (/). Overrides .

Declared In

FMWebSync.h

– channels

Gets the channels to which the client should be subscribed. Each must start with a forward slash (/). Overrides .

- (NSMutableArray *)channels

Discussion

Gets the channels to which the client should be subscribed. Each must start with a forward slash (/). Overrides .

Declared In

FMWebSync.h

– initWithChannel:

Initializes a new instance of the class.

- (id)initWithChannel:(NSString *)channel

Parameters

name="channel">The

channel to subscribe.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

– initWithChannel:tag:

Initializes a new instance of the class.

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

Parameters

name="channel">The

channel to subscribe.
name="tag">The

tag identifying the subscription.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

– initWithChannels:

Initializes a new instance of the class.

- (id)initWithChannels:(NSMutableArray *)channels

Parameters

name="channels">The

channels to subscribe.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

– initWithChannels:tag:

Initializes a new instance of the class.

- (id)initWithChannels:(NSMutableArray *)channels tag:(NSString *)tag

Parameters

name="channels">The

channels to subscribe.
name="tag">The

tag identifying the subscription.

Discussion

Initializes a new instance of the class.

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

– onReceive

Gets the callback to invoke when data is received on the channel(s). See for callback argument details.

- (FMCallback *)onReceive

Discussion

Gets the callback to invoke when data is received on the channel(s). See for callback argument details.

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

– setAutoResubscribe:

Sets whether to call Subscribe with these args immediately after a reconnect following a stream failure. Generally, this should be null. The client will analyze the current context and set this flag as needed. However, it can be overridden for special cases. If set explicitly to false, then the client will assume that this call to Subscribe is being invoked from the OnSuccess callback of another WebSync method call, and therefore will be called again implicitly after a network reconnection. If set to true, then the client will assume this call to Subscribe is being invoked as a part of some external action and will force a Subscribe call using these arguments after a network reconnection. Defaults to null.

- (void)setAutoResubscribe:(FMNullableBool *)value

Discussion

Sets whether to call Subscribe with these args immediately after a reconnect following a stream failure. Generally, this should be null. The client will analyze the current context and set this flag as needed. However, it can be overridden for special cases. If set explicitly to false, then the client will assume that this call to Subscribe is being invoked from the OnSuccess callback of another WebSync method call, and therefore will be called again implicitly after a network reconnection. If set to true, then the client will assume this call to Subscribe is being invoked as a part of some external action and will force a Subscribe call using these arguments after a network reconnection. Defaults to null.

Declared In

FMWebSync.h

– setChannel:

Sets the channel to which the client should be subscribed. Must start with a forward slash (/). Overrides .

- (void)setChannel:(NSString *)value

Discussion

Sets the channel to which the client should be subscribed. Must start with a forward slash (/). Overrides .

Declared In

FMWebSync.h

– setChannels:

Sets the channels to which the client should be subscribed. Each must start with a forward slash (/). Overrides .

- (void)setChannels:(NSMutableArray *)value

Discussion

Sets the channels to which the client should be subscribed. Each must start with a forward slash (/). 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 ( ^ ) ( FMWebSyncSubscribeCompleteArgs *))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 ( ^ ) ( FMWebSyncSubscribeFailureArgs *))valueBlock

Discussion

Sets the callback to invoke if the request fails.

Declared In

FMWebSync.h

– setOnReceive:

Sets the callback to invoke when data is received on the channel(s). See for callback argument details.

- (void)setOnReceive:(FMCallback *)value

Discussion

Sets the callback to invoke when data is received on the channel(s). See for callback argument details.

Declared In

FMWebSync.h

– setOnReceiveBlock:

Sets the callback to invoke when data is received on the channel(s). See for callback argument details.

- (void)setOnReceiveBlock:(void ( ^ ) ( FMWebSyncSubscribeReceiveArgs *))valueBlock

Discussion

Sets the callback to invoke when data is received on the channel(s). See for callback argument details.

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 ( ^ ) ( FMWebSyncSubscribeSuccessArgs *))valueBlock

Discussion

Sets the callback to invoke if the request succeeds.

Declared In

FMWebSync.h

– setTag:

Sets a tag that will uniquely identify this subscription so it can be unsubscribed later without affecting other subscriptions with the same channel.

- (void)setTag:(NSString *)value

Discussion

Sets a tag that will uniquely identify this subscription so it can be unsubscribed later without affecting other subscriptions with the same channel.

Declared In

FMWebSync.h

+ subscribeArgsWithChannel:

Initializes a new instance of the class.

+ (FMWebSyncSubscribeArgs *)subscribeArgsWithChannel:(NSString *)channel

Parameters

name="channel">The

channel to subscribe.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

+ subscribeArgsWithChannel:tag:

Initializes a new instance of the class.

+ (FMWebSyncSubscribeArgs *)subscribeArgsWithChannel:(NSString *)channel tag:(NSString *)tag

Parameters

name="channel">The

channel to subscribe.
name="tag">The

tag identifying the subscription.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

+ subscribeArgsWithChannels:

Initializes a new instance of the class.

+ (FMWebSyncSubscribeArgs *)subscribeArgsWithChannels:(NSMutableArray *)channels

Parameters

name="channels">The

channels to subscribe.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

+ subscribeArgsWithChannels:tag:

Initializes a new instance of the class.

+ (FMWebSyncSubscribeArgs *)subscribeArgsWithChannels:(NSMutableArray *)channels tag:(NSString *)tag

Parameters

name="channels">The

channels to subscribe.
name="tag">The

tag identifying the subscription.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

– tag

Gets a tag that will uniquely identify this subscription so it can be unsubscribed later without affecting other subscriptions with the same channel.

- (NSString *)tag

Discussion

Gets a tag that will uniquely identify this subscription so it can be unsubscribed later without affecting other subscriptions with the same channel.

Declared In

FMWebSync.h

FMWebSyncSubscribersExtensions Methods

– getOnClientSubscribe

Gets the callback invoked when a client subscribes.

- (FMCallback *)getOnClientSubscribe

Parameters

name="args">The

to extend. The callback invoked when a client subscribes.

Discussion

Gets the callback invoked when a client subscribes.

Declared In

FMWebSyncSubscribers.h

+ getOnClientSubscribeWithArgs:

Gets the callback invoked when a client subscribes.

+ (FMCallback *)getOnClientSubscribeWithArgs:(FMWebSyncSubscribeArgs *)args

Parameters

name="args">The

to extend. The callback invoked when a client subscribes.

Discussion

Gets the callback invoked when a client subscribes.

Declared In

FMWebSyncSubscribers.h

– getOnClientUnsubscribe

Gets the callback invoked when a client unsubscribes.

- (FMCallback *)getOnClientUnsubscribe

Parameters

name="args">The

to extend. The callback invoked when a client unsubscribes.

Discussion

Gets the callback invoked when a client unsubscribes.

Declared In

FMWebSyncSubscribers.h

+ getOnClientUnsubscribeWithArgs:

Gets the callback invoked when a client unsubscribes.

+ (FMCallback *)getOnClientUnsubscribeWithArgs:(FMWebSyncSubscribeArgs *)args

Parameters

name="args">The

to extend. The callback invoked when a client unsubscribes.

Discussion

Gets the callback invoked when a client unsubscribes.

Declared In

FMWebSyncSubscribers.h

+ setOnClientSubscribeWithArgs:onClientSubscribe:

Sets a callback to invoke when a client subscribes.

+ (FMWebSyncSubscribeArgs *)setOnClientSubscribeWithArgs:(FMWebSyncSubscribeArgs *)args onClientSubscribe:(FMCallback *)onClientSubscribe

Parameters

name="onClientSubscribe">The

callback to invoke when a client subscribes to the channel(s)). The .
name="args">The

to extend.

Discussion

Sets a callback to invoke when a client subscribes.

Declared In

FMWebSyncSubscribers.h

+ setOnClientSubscribeWithArgs:onClientSubscribeBlock:

Sets a callback to invoke when a client subscribes.

+ (FMWebSyncSubscribeArgs *)setOnClientSubscribeWithArgs:(FMWebSyncSubscribeArgs *)args onClientSubscribeBlock:(void ( ^ ) ( FMWebSyncSubscribersClientSubscribeArgs *))onClientSubscribeBlock

Parameters

name="onClientSubscribe">The

callback to invoke when a client subscribes to the channel(s)). The .
name="args">The

to extend.

Discussion

Sets a callback to invoke when a client subscribes.

Declared In

FMWebSyncSubscribers.h

– setOnClientSubscribeWithOnClientSubscribe:

Sets a callback to invoke when a client subscribes.

- (FMWebSyncSubscribeArgs *)setOnClientSubscribeWithOnClientSubscribe:(FMCallback *)onClientSubscribe

Parameters

name="args">The

to extend.
name="onClientSubscribe">The

callback to invoke when a client subscribes to the channel(s)). The .

Discussion

Sets a callback to invoke when a client subscribes.

Declared In

FMWebSyncSubscribers.h

– setOnClientSubscribe:

Sets a callback to invoke when a client subscribes.

- (FMWebSyncSubscribeArgs *)setOnClientSubscribe:(FMCallback *)onClientSubscribe

Parameters

name="args">The

to extend.
name="onClientSubscribe">The

callback to invoke when a client subscribes to the channel(s)). The .

Discussion

Sets a callback to invoke when a client subscribes.

Declared In

FMWebSyncSubscribers.h

– setOnClientSubscribeWithOnClientSubscribeBlock:

Sets a callback to invoke when a client subscribes.

- (FMWebSyncSubscribeArgs *)setOnClientSubscribeWithOnClientSubscribeBlock:(void ( ^ ) ( FMWebSyncSubscribersClientSubscribeArgs *))onClientSubscribeBlock

Parameters

name="args">The

to extend.
name="onClientSubscribe">The

callback to invoke when a client subscribes to the channel(s)). The .

Discussion

Sets a callback to invoke when a client subscribes.

Declared In

FMWebSyncSubscribers.h

– setOnClientSubscribeBlock:

Sets a callback to invoke when a client subscribes.

- (FMWebSyncSubscribeArgs *)setOnClientSubscribeBlock:(void ( ^ ) ( FMWebSyncSubscribersClientSubscribeArgs *))onClientSubscribeBlock

Parameters

name="args">The

to extend.
name="onClientSubscribe">The

callback to invoke when a client subscribes to the channel(s)). The .

Discussion

Sets a callback to invoke when a client subscribes.

Declared In

FMWebSyncSubscribers.h

+ setOnClientUnsubscribeWithArgs:onClientUnsubscribe:

Sets a callback to invoke when a client unsubscribes.

+ (FMWebSyncSubscribeArgs *)setOnClientUnsubscribeWithArgs:(FMWebSyncSubscribeArgs *)args onClientUnsubscribe:(FMCallback *)onClientUnsubscribe

Parameters

name="onClientUnsubscribe">The

callback to invoke when a client unsubscribes from the channel(s)). The .
name="args">The

to extend.

Discussion

Sets a callback to invoke when a client unsubscribes.

Declared In

FMWebSyncSubscribers.h

+ setOnClientUnsubscribeWithArgs:onClientUnsubscribeBlock:

Sets a callback to invoke when a client unsubscribes.

+ (FMWebSyncSubscribeArgs *)setOnClientUnsubscribeWithArgs:(FMWebSyncSubscribeArgs *)args onClientUnsubscribeBlock:(void ( ^ ) ( FMWebSyncSubscribersClientUnsubscribeArgs *))onClientUnsubscribeBlock

Parameters

name="onClientUnsubscribe">The

callback to invoke when a client unsubscribes from the channel(s)). The .
name="args">The

to extend.

Discussion

Sets a callback to invoke when a client unsubscribes.

Declared In

FMWebSyncSubscribers.h

– setOnClientUnsubscribeWithOnClientUnsubscribe:

Sets a callback to invoke when a client unsubscribes.

- (FMWebSyncSubscribeArgs *)setOnClientUnsubscribeWithOnClientUnsubscribe:(FMCallback *)onClientUnsubscribe

Parameters

name="args">The

to extend.
name="onClientUnsubscribe">The

callback to invoke when a client unsubscribes from the channel(s)). The .

Discussion

Sets a callback to invoke when a client unsubscribes.

Declared In

FMWebSyncSubscribers.h

– setOnClientUnsubscribe:

Sets a callback to invoke when a client unsubscribes.

- (FMWebSyncSubscribeArgs *)setOnClientUnsubscribe:(FMCallback *)onClientUnsubscribe

Parameters

name="args">The

to extend.
name="onClientUnsubscribe">The

callback to invoke when a client unsubscribes from the channel(s)). The .

Discussion

Sets a callback to invoke when a client unsubscribes.

Declared In

FMWebSyncSubscribers.h

– setOnClientUnsubscribeWithOnClientUnsubscribeBlock:

Sets a callback to invoke when a client unsubscribes.

- (FMWebSyncSubscribeArgs *)setOnClientUnsubscribeWithOnClientUnsubscribeBlock:(void ( ^ ) ( FMWebSyncSubscribersClientUnsubscribeArgs *))onClientUnsubscribeBlock

Parameters

name="args">The

to extend.
name="onClientUnsubscribe">The

callback to invoke when a client unsubscribes from the channel(s)). The .

Discussion

Sets a callback to invoke when a client unsubscribes.

Declared In

FMWebSyncSubscribers.h

– setOnClientUnsubscribeBlock:

Sets a callback to invoke when a client unsubscribes.

- (FMWebSyncSubscribeArgs *)setOnClientUnsubscribeBlock:(void ( ^ ) ( FMWebSyncSubscribersClientUnsubscribeArgs *))onClientUnsubscribeBlock

Parameters

name="args">The

to extend.
name="onClientUnsubscribe">The

callback to invoke when a client unsubscribes from the channel(s)). The .

Discussion

Sets a callback to invoke when a client unsubscribes.

Declared In

FMWebSyncSubscribers.h