FMWebSyncRecord Class Reference

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

Overview

A key-value record for binding to a client.

– duplicate

Creates a deep clone of this record. A deep clone of this record.

- (FMWebSyncRecord *)duplicate

Discussion

Creates a deep clone of this record. A deep clone of this record.

Declared In

FMWebSync.h

+ fromJsonMultipleWithRecordsJson:

Deserializes a list of records from JSON.

+ (NSMutableArray *)fromJsonMultipleWithRecordsJson:(NSString *)recordsJson

Parameters

name="recordsJson">A

JSON string to deserialize. A deserialized list of records.

Discussion

Deserializes a list of records from JSON.

Declared In

FMWebSync.h

+ fromJsonWithRecordJson:

Deserializes a record from JSON.

+ (FMWebSyncRecord *)fromJsonWithRecordJson:(NSString *)recordJson

Parameters

name="recordJson">A

JSON string to deserialize. A deserialized record.

Discussion

Deserializes a record from JSON.

Declared In

FMWebSync.h

– hash

Returns a hash code for this instance. A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

- (int)hash

Discussion

Returns a hash code for this instance. A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

Declared In

FMWebSync.h

– initWithKey:

Initializes a new instance of the class.

- (id)initWithKey:(NSString *)key

Parameters

name="key">The

key used to locate the value.

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

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

key used to locate the value.

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

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

key used to locate the value.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

– isEqualWithObj:

Determines whether the specified object is equal to this instance.

- (bool)isEqualWithObj:(NSObject *)obj

Parameters

name="obj">The

object to compare with this instance. true if the specified object is equal to this instance; otherwise, false.

Discussion

Determines whether the specified object is equal to this instance.

Declared In

FMWebSync.h

– key

Gets the key used to locate the value.

- (NSString *)key

Discussion

Gets the key used to locate the value.

Declared In

FMWebSync.h

– private

Gets the flag that indicates whether or not the record is (to be) hidden from other clients. If true, the record will only be visible to the source client and the server. If false or null, the record will be publicly visible to other clients. Defaults to null.

- (bool)private

Discussion

Gets the flag that indicates whether or not the record is (to be) hidden from other clients. If true, the record will only be visible to the source client and the server. If false or null, the record will be publicly visible to other clients. Defaults to null.

Declared In

FMWebSync.h

+ recordWithKey:

Initializes a new instance of the class.

+ (FMWebSyncRecord *)recordWithKey:(NSString *)key

Parameters

name="key">The

key used to locate the value.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

+ recordWithKey:valueJson:

Initializes a new instance of the class.

+ (FMWebSyncRecord *)recordWithKey:(NSString *)key valueJson:(NSString *)valueJson

Parameters

name="valueJson">The

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

key used to locate the value.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

+ recordWithKey:valueJson:priv:

Initializes a new instance of the class.

+ (FMWebSyncRecord *)recordWithKey:(NSString *)key valueJson:(NSString *)valueJson priv:(bool)priv

Parameters

name="priv">Whether

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

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

key used to locate the value.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

– setKey:

Sets the key used to locate the value.

- (void)setKey:(NSString *)value

Discussion

Sets the key used to locate the value.

Declared In

FMWebSync.h

– setPrivate:

Sets the flag that indicates whether or not the record is (to be) hidden from other clients. If true, the record will only be visible to the source client and the server. If false or null, the record will be publicly visible to other clients. Defaults to null.

- (void)setPrivate:(bool)value

Discussion

Sets the flag that indicates whether or not the record is (to be) hidden from other clients. If true, the record will only be visible to the source client and the server. If false or null, the record will be publicly visible to other clients. Defaults to null.

Declared In

FMWebSync.h

– setValueJson:

Sets the record value. This must be valid JSON.

- (void)setValueJson:(NSString *)value

Discussion

Sets the record value. This must be valid JSON.

Declared In

FMWebSync.h

– toJson

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

- (NSString *)toJson

Discussion

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

Declared In

FMWebSync.h

+ toJsonMultipleWithRecords:

Serializes a list of records to JSON.

+ (NSString *)toJsonMultipleWithRecords:(NSMutableArray *)records

Parameters

name="records">A

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

Discussion

Serializes a list of records to JSON.

Declared In

FMWebSync.h

+ toJsonWithRecord:

Serializes a record to JSON.

+ (NSString *)toJsonWithRecord:(FMWebSyncRecord *)record

Parameters

name="record">A

record to serialize. A JSON-serialized record.

Discussion

Serializes a record to JSON.

Declared In

FMWebSync.h

– toString

Returns a string that represents this instance. A string that represents this instance.

- (NSString *)toString

Discussion

Returns a string that represents this instance. A string that represents this instance.

Declared In

FMWebSync.h

– description

Returns a string that represents this instance. A string that represents this instance.

- (NSString *)description

Discussion

Returns a string that represents this instance. A string that represents this instance.

Declared In

FMWebSync.h

– valueJson

Gets the record value. This must be valid JSON.

- (NSString *)valueJson

Discussion

Gets the record value. This must be valid JSON.

Declared In

FMWebSync.h