FMWebSyncBindArgs Class Reference

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

Overview

Arguments for client bind requests.

– autoRebind

Gets whether to call Bind 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 Bind 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 Bind is being invoked as a part of some external action and will force a Bind call using these arguments after a network reconnection. Defaults to null.

- (FMNullableBool *)autoRebind

Discussion

Gets whether to call Bind 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 Bind 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 Bind is being invoked as a part of some external action and will force a Bind call using these arguments after a network reconnection. Defaults to null.

Declared In

FMWebSync.h

+ bindArgsWithKey:valueJson:

Initializes a new instance of the class.

+ (FMWebSyncBindArgs *)bindArgsWithKey:(NSString *)key valueJson:(NSString *)valueJson

Parameters

name="valueJson">The

record value in JSON format.
name="key">The

record key.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

+ bindArgsWithKey:valueJson:priv:

Initializes a new instance of the class.

+ (FMWebSyncBindArgs *)bindArgsWithKey:(NSString *)key valueJson:(NSString *)valueJson priv:(bool)priv

Parameters

name="priv">Whether

the record is (to be) private.
name="valueJson">The

record value in JSON format.
name="key">The

record key.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

+ bindArgsWithRecord:

Initializes a new instance of the class.

+ (FMWebSyncBindArgs *)bindArgsWithRecord:(FMWebSyncRecord *)record

Parameters

name="record">The

record to bind.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

+ bindArgsWithRecords:

Initializes a new instance of the class.

+ (FMWebSyncBindArgs *)bindArgsWithRecords:(NSMutableArray *)records

Parameters

name="records">The

records to bind.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

– initWithKey:valueJson:

Initializes a new instance of the class.

- (id)initWithKey:(NSString *)key valueJson:(NSString *)valueJson

Parameters

name="valueJson">The

record value in JSON format.
name="key">The

record key.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

– initWithKey:valueJson:priv:

Initializes a new instance of the class.

- (id)initWithKey:(NSString *)key valueJson:(NSString *)valueJson priv:(bool)priv

Parameters

name="priv">Whether

the record is (to be) private.
name="valueJson">The

record value in JSON format.
name="key">The

record key.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

– initWithRecord:

Initializes a new instance of the class.

- (id)initWithRecord:(FMWebSyncRecord *)record

Parameters

name="record">The

record to bind.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

– initWithRecords:

Initializes a new instance of the class.

- (id)initWithRecords:(NSMutableArray *)records

Parameters

name="records">The

records to bind.

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

– 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

– record

Gets the record to bind. Overrides .

- (FMWebSyncRecord *)record

Discussion

Gets the record to bind. Overrides .

Declared In

FMWebSync.h

– records

Gets the records to bind. Overrides .

- (NSMutableArray *)records

Discussion

Gets the records to bind. Overrides .

Declared In

FMWebSync.h

– setAutoRebind:

Sets whether to call Bind 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 Bind 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 Bind is being invoked as a part of some external action and will force a Bind call using these arguments after a network reconnection. Defaults to null.

- (void)setAutoRebind:(FMNullableBool *)value

Discussion

Sets whether to call Bind 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 Bind 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 Bind is being invoked as a part of some external action and will force a Bind call using these arguments after a network reconnection. Defaults to null.

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 ( ^ ) ( FMWebSyncBindCompleteArgs *))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 ( ^ ) ( FMWebSyncBindFailureArgs *))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 ( ^ ) ( FMWebSyncBindSuccessArgs *))valueBlock

Discussion

Sets the callback to invoke if the request succeeds.

Declared In

FMWebSync.h

– setRecord:

Sets the record to bind. Overrides .

- (void)setRecord:(FMWebSyncRecord *)value

Discussion

Sets the record to bind. Overrides .

Declared In

FMWebSync.h

– setRecords:

Sets the records to bind. Overrides .

- (void)setRecords:(NSMutableArray *)value

Discussion

Sets the records to bind. Overrides .

Declared In

FMWebSync.h