FMWebSyncMessage Class Reference

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

Overview

The WebSync message used for all requests/responses.

– acknowledgement

Gets the acknowledgement flag, used internally for stream requests following message delivery.

- (FMNullableBool *)acknowledgement

Discussion

Gets the acknowledgement flag, used internally for stream requests following message delivery.

Declared In

FMWebSync.h

– advice

Gets details on how the client should reconnect, used internally.

- (FMWebSyncAdvice *)advice

Discussion

Gets details on how the client should reconnect, used internally.

Declared In

FMWebSync.h

– bayeuxChannel

Gets the Bayeux message channel.

- (NSString *)bayeuxChannel

Discussion

Gets the Bayeux message channel.

Declared In

FMWebSync.h

– channel

Gets the channel to which the current client is publishing, subscribing, or unsubscribing. Overrides .

- (NSString *)channel

Discussion

Gets the channel to which the current client is publishing, subscribing, or unsubscribing. Overrides .

Declared In

FMWebSync.h

– channels

Gets the channels to which the current client is subscribing or unsubscribing. Overrides .

- (NSMutableArray *)channels

Discussion

Gets the channels to which the current client is subscribing or unsubscribing. Overrides .

Declared In

FMWebSync.h

– clientId

Gets the unique identifier of the current client associated with the request/response.

- (FMNullableGuid *)clientId

Discussion

Gets the unique identifier of the current client associated with the request/response.

Declared In

FMWebSync.h

– connectionType

Gets the type of connection the client is using, used internally.

- (FMWebSyncNullableConnectionType *)connectionType

Discussion

Gets the type of connection the client is using, used internally.

Declared In

FMWebSync.h

– disableBinary

Gets whether binary is disabled.

- (FMNullableBool *)disableBinary

Discussion

Gets whether binary is disabled.

Declared In

FMWebSync.h

+ fromBinaryMultipleWithBytes:

Deserializes a list of messages from binary.

+ (NSMutableArray *)fromBinaryMultipleWithBytes:(NSMutableData *)bytes

Parameters

name="bytes">A

byte array to deserialize. A deserialized list of messages.

Discussion

Deserializes a list of messages from binary.

Declared In

FMWebSync.h

+ fromBinaryWithBytes:

Deserializes a message from binary.

+ (FMWebSyncMessage *)fromBinaryWithBytes:(NSMutableData *)bytes

Parameters

name="bytes">A

byte array to deserialize. A deserialized message.

Discussion

Deserializes a message from binary.

Declared In

FMWebSync.h

+ fromBinaryWithBytes:offset:

Deserializes a message from binary.

+ (FMWebSyncMessage *)fromBinaryWithBytes:(NSMutableData *)bytes offset:(int)offset

Parameters

name="bytes">A

byte array to deserialize.
name="offset">The

offset into the array. A deserialized message.

Discussion

Deserializes a message from binary.

Declared In

FMWebSync.h

+ fromJsonMultipleWithMessagesJson:

Deserializes a list of messages from JSON.

+ (NSMutableArray *)fromJsonMultipleWithMessagesJson:(NSString *)messagesJson

Parameters

name="messagesJson">A

JSON string to deserialize. A deserialized list of messages.

Discussion

Deserializes a list of messages from JSON.

Declared In

FMWebSync.h

+ fromJsonWithMessageJson:

Deserializes a message from JSON.

+ (FMWebSyncMessage *)fromJsonWithMessageJson:(NSString *)messageJson

Parameters

name="messageJson">A

JSON string to deserialize. A deserialized message.

Discussion

Deserializes a message from JSON.

Declared In

FMWebSync.h

– id

Gets the unique message identifier.

- (NSString *)id

Discussion

Gets the unique message identifier.

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

– initWithBayeuxChannel:

Initializes a new instance of the class.

- (id)initWithBayeuxChannel:(NSString *)bayeuxChannel

Parameters

name="bayeuxChannel">The

Bayeux channel with which to initialize the message.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

– isBind

Detects whether this is a bind request/response.

- (bool)isBind

Discussion

Detects whether this is a bind request/response.

Declared In

FMWebSync.h

– isBindingToWithKey:

Determines whether or not the current message represents a bind request/response for a particular key.

- (bool)isBindingToWithKey:(NSString *)key

Parameters

name="key">The

key to test. true if the message represents a bind request/response for the specified key; otherwise false.

Discussion

Determines whether or not the current message represents a bind request/response for a particular key.

Declared In

FMWebSync.h

– isConnect

Detects whether this is a connect request/response.

- (bool)isConnect

Discussion

Detects whether this is a connect request/response.

Declared In

FMWebSync.h

– isDisconnect

Detects whether this is a disconnect request/response.

- (bool)isDisconnect

Discussion

Detects whether this is a disconnect request/response.

Declared In

FMWebSync.h

– isNotify

Detects whether this is a notify request/response.

- (bool)isNotify

Discussion

Detects whether this is a notify request/response.

Declared In

FMWebSync.h

– isPublish

Detects whether this is a publish request/response.

- (bool)isPublish

Discussion

Detects whether this is a publish request/response.

Declared In

FMWebSync.h

– isService

Detects whether this is a service request/response.

- (bool)isService

Discussion

Detects whether this is a service request/response.

Declared In

FMWebSync.h

– isStream

Detects whether this is a stream request/response.

- (bool)isStream

Discussion

Detects whether this is a stream request/response.

Declared In

FMWebSync.h

– isSubscribe

Detects whether this is a subscribe request/response.

- (bool)isSubscribe

Discussion

Detects whether this is a subscribe request/response.

Declared In

FMWebSync.h

– isSubscribingToWithChannel:

Determines whether or not the current message represents a subscribe request/response for a particular channel.

- (bool)isSubscribingToWithChannel:(NSString *)channel

Parameters

name="channel">The

channel to test. true if the message represents a subscribe request/response for the specified channel; otherwise false.

Discussion

Determines whether or not the current message represents a subscribe request/response for a particular channel.

Declared In

FMWebSync.h

– isUnbind

Detects whether this is a bind request/response.

- (bool)isUnbind

Discussion

Detects whether this is a bind request/response.

Declared In

FMWebSync.h

– isUnbindingFromWithKey:

Determines whether or not the current message represents an unbind request/response for a particular key.

- (bool)isUnbindingFromWithKey:(NSString *)key

Parameters

name="key">The

key to test. true if the message represents an unbind request/response for the specified key; otherwise false.

Discussion

Determines whether or not the current message represents an unbind request/response for a particular key.

Declared In

FMWebSync.h

– isUnsubscribe

Detects whether this is an unsubscribe request/response.

- (bool)isUnsubscribe

Discussion

Detects whether this is an unsubscribe request/response.

Declared In

FMWebSync.h

– isUnsubscribingFromWithChannel:

Determines whether or not the current message represents an unsubscribe request/response for a particular channel.

- (bool)isUnsubscribingFromWithChannel:(NSString *)channel

Parameters

name="channel">The

channel to test. true if the message represents an unsubscribe request/response for the specified channel; otherwise false.

Discussion

Determines whether or not the current message represents an unsubscribe request/response for a particular channel.

Declared In

FMWebSync.h

– key

Gets the record key to which the current client is binding or unbinding. Overrides , , and .

- (NSString *)key

Discussion

Gets the record key to which the current client is binding or unbinding. Overrides , , and .

Declared In

FMWebSync.h

– keys

Gets the record keys to which the current client is binding or unbinding. Overrides , , and .

- (NSMutableArray *)keys

Discussion

Gets the record keys to which the current client is binding or unbinding. Overrides , , and .

Declared In

FMWebSync.h

– lastClientId

Gets the last used client ID.

- (FMNullableGuid *)lastClientId

Discussion

Gets the last used client ID.

Declared In

FMWebSync.h

– lastSessionId

Gets the last used session ID.

- (FMNullableGuid *)lastSessionId

Discussion

Gets the last used session ID.

Declared In

FMWebSync.h

+ messageWithBayeuxChannel:

Initializes a new instance of the class.

+ (FMWebSyncMessage *)messageWithBayeuxChannel:(NSString *)bayeuxChannel

Parameters

name="bayeuxChannel">The

Bayeux channel with which to initialize the message.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSync.h

– minimumVersion

Gets the minimum supported server version, used internally.

- (NSString *)minimumVersion

Discussion

Gets the minimum supported server version, used internally.

Declared In

FMWebSync.h

– notifyClientId

Gets the ID of the client which the current client is notifying.

- (FMNullableGuid *)notifyClientId

Discussion

Gets the ID of the client which the current client is notifying.

Declared In

FMWebSync.h

– notifyingClient

Gets the notifying client details, used internally.

- (FMWebSyncNotifyingClient *)notifyingClient

Discussion

Gets the notifying client details, used internally.

Declared In

FMWebSync.h

– publishingClient

Gets the publishing client details, used internally.

- (FMWebSyncPublishingClient *)publishingClient

Discussion

Gets the publishing client details, used internally.

Declared In

FMWebSync.h

– record

Gets the record to which the current client is binding or unbinding. Overrides , , and .

- (FMWebSyncRecord *)record

Discussion

Gets the record to which the current client is binding or unbinding. Overrides , , and .

Declared In

FMWebSync.h

– records

Gets the records to which the current client is binding or unbinding. Overrides , , and .

- (NSMutableArray *)records

Discussion

Gets the records to which the current client is binding or unbinding. Overrides , , and .

Declared In

FMWebSync.h

– serverActions

Gets the server actions, used internally.

- (NSMutableArray *)serverActions

Discussion

Gets the server actions, used internally.

Declared In

FMWebSync.h

– serverTimeout

Gets the server timeout, used internally.

- (FMNullableInt *)serverTimeout

Discussion

Gets the server timeout, used internally.

Declared In

FMWebSync.h

– sessionId

Gets the session ID associated with the message, used internally.

- (FMNullableGuid *)sessionId

Discussion

Gets the session ID associated with the message, used internally.

Declared In

FMWebSync.h

– setAcknowledgement:

Sets the acknowledgement flag, used internally for stream requests following message delivery.

- (void)setAcknowledgement:(FMNullableBool *)value

Discussion

Sets the acknowledgement flag, used internally for stream requests following message delivery.

Declared In

FMWebSync.h

– setAdvice:

Sets details on how the client should reconnect, used internally.

- (void)setAdvice:(FMWebSyncAdvice *)value

Discussion

Sets details on how the client should reconnect, used internally.

Declared In

FMWebSync.h

– setBayeuxChannel:

Sets the Bayeux message channel.

- (void)setBayeuxChannel:(NSString *)value

Discussion

Sets the Bayeux message channel.

Declared In

FMWebSync.h

– setChannel:

Sets the channel to which the current client is publishing, subscribing, or unsubscribing. Overrides .

- (void)setChannel:(NSString *)value

Discussion

Sets the channel to which the current client is publishing, subscribing, or unsubscribing. Overrides .

Declared In

FMWebSync.h

– setChannels:

Sets the channels to which the current client is subscribing or unsubscribing. Overrides .

- (void)setChannels:(NSMutableArray *)value

Discussion

Sets the channels to which the current client is subscribing or unsubscribing. Overrides .

Declared In

FMWebSync.h

– setClientId:

Sets the unique identifier of the current client associated with the request/response.

- (void)setClientId:(FMNullableGuid *)value

Discussion

Sets the unique identifier of the current client associated with the request/response.

Declared In

FMWebSync.h

– setConnectionType:

Sets the type of connection the client is using, used internally.

- (void)setConnectionType:(FMWebSyncNullableConnectionType *)value

Discussion

Sets the type of connection the client is using, used internally.

Declared In

FMWebSync.h

– setDisableBinary:

Sets whether binary is disabled.

- (void)setDisableBinary:(FMNullableBool *)value

Discussion

Sets whether binary is disabled.

Declared In

FMWebSync.h

– setId:

Sets the unique message identifier.

- (void)setId:(NSString *)value

Discussion

Sets the unique message identifier.

Declared In

FMWebSync.h

– setKey:

Sets the record key to which the current client is binding or unbinding. Overrides , , and .

- (void)setKey:(NSString *)value

Discussion

Sets the record key to which the current client is binding or unbinding. Overrides , , and .

Declared In

FMWebSync.h

– setKeys:

Sets the record keys to which the current client is binding or unbinding. Overrides , , and .

- (void)setKeys:(NSMutableArray *)value

Discussion

Sets the record keys to which the current client is binding or unbinding. Overrides , , and .

Declared In

FMWebSync.h

– setLastClientId:

Sets the last used client ID.

- (void)setLastClientId:(FMNullableGuid *)value

Discussion

Sets the last used client ID.

Declared In

FMWebSync.h

– setLastSessionId:

Sets the last used session ID.

- (void)setLastSessionId:(FMNullableGuid *)value

Discussion

Sets the last used session ID.

Declared In

FMWebSync.h

– setMinimumVersion:

Sets the minimum supported server version, used internally.

- (void)setMinimumVersion:(NSString *)value

Discussion

Sets the minimum supported server version, used internally.

Declared In

FMWebSync.h

– setNotifyClientId:

Sets the ID of the client which the current client is notifying.

- (void)setNotifyClientId:(FMNullableGuid *)value

Discussion

Sets the ID of the client which the current client is notifying.

Declared In

FMWebSync.h

– setNotifyingClient:

Sets the notifying client details, used internally.

- (void)setNotifyingClient:(FMWebSyncNotifyingClient *)value

Discussion

Sets the notifying client details, used internally.

Declared In

FMWebSync.h

– setPublishingClient:

Sets the publishing client details, used internally.

- (void)setPublishingClient:(FMWebSyncPublishingClient *)value

Discussion

Sets the publishing client details, used internally.

Declared In

FMWebSync.h

– setRecord:

Sets the record to which the current client is binding or unbinding. Overrides , , and .

- (void)setRecord:(FMWebSyncRecord *)value

Discussion

Sets the record to which the current client is binding or unbinding. Overrides , , and .

Declared In

FMWebSync.h

– setRecords:

Sets the records to which the current client is binding or unbinding. Overrides , , and .

- (void)setRecords:(NSMutableArray *)value

Discussion

Sets the records to which the current client is binding or unbinding. Overrides , , and .

Declared In

FMWebSync.h

– setServerActions:

Sets the server actions, used internally.

- (void)setServerActions:(NSMutableArray *)value

Discussion

Sets the server actions, used internally.

Declared In

FMWebSync.h

– setServerTimeout:

Sets the server timeout, used internally.

- (void)setServerTimeout:(FMNullableInt *)value

Discussion

Sets the server timeout, used internally.

Declared In

FMWebSync.h

– setSessionId:

Sets the session ID associated with the message, used internally.

- (void)setSessionId:(FMNullableGuid *)value

Discussion

Sets the session ID associated with the message, used internally.

Declared In

FMWebSync.h

– setSupportedConnectionTypes:

Sets the connection types supported by an endpoint, used internally.

- (void)setSupportedConnectionTypes:(NSMutableArray *)value

Discussion

Sets the connection types supported by an endpoint, used internally.

Declared In

FMWebSync.h

– setTag:

Sets the tag associated with the request.

- (void)setTag:(NSString *)value

Discussion

Sets the tag associated with the request.

Declared In

FMWebSync.h

– setVersion:

Sets the current server version, used internally.

- (void)setVersion:(NSString *)value

Discussion

Sets the current server version, used internally.

Declared In

FMWebSync.h

– supportedConnectionTypes

Gets the connection types supported by an endpoint, used internally.

- (NSMutableArray *)supportedConnectionTypes

Discussion

Gets the connection types supported by an endpoint, used internally.

Declared In

FMWebSync.h

– tag

Gets the tag associated with the request.

- (NSString *)tag

Discussion

Gets the tag associated with the request.

Declared In

FMWebSync.h

– toBinary

Serializes the message to binary. The message in binary-serialized format.

- (NSMutableData *)toBinary

Discussion

Serializes the message to binary. The message in binary-serialized format.

Declared In

FMWebSync.h

+ toBinaryMultipleWithMessages:

Serializes a list of messages to binary.

+ (NSMutableData *)toBinaryMultipleWithMessages:(NSMutableArray *)messages

Parameters

name="messages">A

list of messages to serialize. A binary-serialized array of messages.

Discussion

Serializes a list of messages to binary.

Declared In

FMWebSync.h

+ toBinaryWithMessage:

Serializes a message to binary.

+ (NSMutableData *)toBinaryWithMessage:(FMWebSyncMessage *)message

Parameters

name="message">A

message to serialize. A binary-serialized message.

Discussion

Serializes a message to binary.

Declared In

FMWebSync.h

– toJson

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

- (NSString *)toJson

Discussion

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

Declared In

FMWebSync.h

+ toJsonMultipleWithMessages:

Serializes a list of messages to JSON.

+ (NSString *)toJsonMultipleWithMessages:(NSMutableArray *)messages

Parameters

name="messages">A

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

Discussion

Serializes a list of messages to JSON.

Declared In

FMWebSync.h

+ toJsonWithMessage:

Serializes a message to JSON.

+ (NSString *)toJsonWithMessage:(FMWebSyncMessage *)message

Parameters

name="message">A

message to serialize. A JSON-serialized message.

Discussion

Serializes a message to JSON.

Declared In

FMWebSync.h

– type

Gets the type of the message.

- (FMWebSyncMessageType)type

Discussion

Gets the type of the message.

Declared In

FMWebSync.h

– version

Gets the current server version, used internally.

- (NSString *)version

Discussion

Gets the current server version, used internally.

Declared In

FMWebSync.h