FMWebSyncNotification Class Reference

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

Overview

The WebSync notification used for direct notifying.

– clientId

Gets the client ID the publisher is targeting.

- (FMGuid *)clientId

Discussion

Gets the client ID the publisher is targeting.

Declared In

FMWebSync.h

+ fromJsonMultipleWithNotificationsJson:

Deserializes a list of notifications from JSON.

+ (NSMutableArray *)fromJsonMultipleWithNotificationsJson:(NSString *)notificationsJson

Parameters

name="notificationsJson">A

JSON string to deserialize. A deserialized list of notifications.

Discussion

Deserializes a list of notifications from JSON.

Declared In

FMWebSync.h

+ fromJsonWithNotificationJson:

Deserializes a notification from JSON.

+ (FMWebSyncNotification *)fromJsonWithNotificationJson:(NSString *)notificationJson

Parameters

name="notificationJson">A

JSON string to deserialize. A deserialized notification.

Discussion

Deserializes a notification from JSON.

Declared In

FMWebSync.h

+ fromMessagesWithMessages:

Converts a set of Notifications from their Message formats.

+ (NSMutableArray *)fromMessagesWithMessages:(NSMutableArray *)messages

Parameters

name="messages">The

messages. The notifications.

Discussion

Converts a set of Notifications from their Message formats.

Declared In

FMWebSync.h

+ fromMessages:

Converts a set of Notifications from their Message formats.

+ (NSMutableArray *)fromMessages:(NSMutableArray *)messages

Parameters

name="messages">The

messages. The notifications.

Discussion

Converts a set of Notifications from their Message formats.

Declared In

FMWebSync.h

+ fromMessageWithMessage:

Converts a Notification from its Message format.

+ (FMWebSyncNotification *)fromMessageWithMessage:(FMWebSyncMessage *)message

Parameters

name="message">The

message. The notification.

Discussion

Converts a Notification from its Message format.

Declared In

FMWebSync.h

+ fromMessage:

Converts a Notification from its Message format.

+ (FMWebSyncNotification *)fromMessage:(FMWebSyncMessage *)message

Parameters

name="message">The

message. The notification.

Discussion

Converts a Notification from its Message format.

Declared In

FMWebSync.h

– init

Creates a new notification.

- (id)init

Discussion

Creates a new notification.

Declared In

FMWebSync.h

– initWithClientId:

Creates a new notification with a client ID.

- (id)initWithClientId:(FMGuid *)clientId

Parameters

name="clientId">The

client ID to target.

Discussion

Creates a new notification with a client ID.

Declared In

FMWebSync.h

– initWithClientId:dataBytes:

Creates a new notification with a client ID and JSON data.

- (id)initWithClientId:(FMGuid *)clientId dataBytes:(NSMutableData *)dataBytes

Parameters

name="dataBytes">The

data to send (in binary format).
name="clientId">The

client ID to target.

Discussion

Creates a new notification with a client ID and JSON data.

Declared In

FMWebSync.h

– initWithClientId:dataBytes:tag:

Creates a new notification with a client ID and JSON data.

- (id)initWithClientId:(FMGuid *)clientId dataBytes:(NSMutableData *)dataBytes tag:(NSString *)tag

Parameters

name="tag">The

tag that identifies the contents of the payload.
name="dataBytes">The

data to send (in binary format).
name="clientId">The

client ID to target.

Discussion

Creates a new notification with a client ID and JSON data.

Declared In

FMWebSync.h

– initWithClientId:dataJson:

Creates a new notification with a client ID and JSON data.

- (id)initWithClientId:(FMGuid *)clientId dataJson:(NSString *)dataJson

Parameters

name="dataJson">The

data to send (in JSON format).
name="clientId">The

client ID to target.

Discussion

Creates a new notification with a client ID and JSON data.

Declared In

FMWebSync.h

– initWithClientId:dataJson:tag:

Creates a new notification with a client ID and JSON data.

- (id)initWithClientId:(FMGuid *)clientId dataJson:(NSString *)dataJson tag:(NSString *)tag

Parameters

name="dataJson">The

data to send (in JSON format).
name="tag">The

tag that identifies the contents of the payload.
name="clientId">The

client ID to target.

Discussion

Creates a new notification with a client ID and JSON data.

Declared In

FMWebSync.h

+ notification

Creates a new notification.

+ (FMWebSyncNotification *)notification

Discussion

Creates a new notification.

Declared In

FMWebSync.h

+ notificationWithClientId:

Creates a new notification with a client ID.

+ (FMWebSyncNotification *)notificationWithClientId:(FMGuid *)clientId

Parameters

name="clientId">The

client ID to target.

Discussion

Creates a new notification with a client ID.

Declared In

FMWebSync.h

+ notificationWithClientId:dataBytes:

Creates a new notification with a client ID and JSON data.

+ (FMWebSyncNotification *)notificationWithClientId:(FMGuid *)clientId dataBytes:(NSMutableData *)dataBytes

Parameters

name="dataBytes">The

data to send (in binary format).
name="clientId">The

client ID to target.

Discussion

Creates a new notification with a client ID and JSON data.

Declared In

FMWebSync.h

+ notificationWithClientId:dataBytes:tag:

Creates a new notification with a client ID and JSON data.

+ (FMWebSyncNotification *)notificationWithClientId:(FMGuid *)clientId dataBytes:(NSMutableData *)dataBytes tag:(NSString *)tag

Parameters

name="tag">The

tag that identifies the contents of the payload.
name="dataBytes">The

data to send (in binary format).
name="clientId">The

client ID to target.

Discussion

Creates a new notification with a client ID and JSON data.

Declared In

FMWebSync.h

+ notificationWithClientId:dataJson:

Creates a new notification with a client ID and JSON data.

+ (FMWebSyncNotification *)notificationWithClientId:(FMGuid *)clientId dataJson:(NSString *)dataJson

Parameters

name="dataJson">The

data to send (in JSON format).
name="clientId">The

client ID to target.

Discussion

Creates a new notification with a client ID and JSON data.

Declared In

FMWebSync.h

+ notificationWithClientId:dataJson:tag:

Creates a new notification with a client ID and JSON data.

+ (FMWebSyncNotification *)notificationWithClientId:(FMGuid *)clientId dataJson:(NSString *)dataJson tag:(NSString *)tag

Parameters

name="dataJson">The

data to send (in JSON format).
name="tag">The

tag that identifies the contents of the payload.
name="clientId">The

client ID to target.

Discussion

Creates a new notification with a client ID and JSON data.

Declared In

FMWebSync.h

– setClientId:

Sets the client ID the publisher is targeting.

- (void)setClientId:(FMGuid *)value

Discussion

Sets the client ID the publisher is targeting.

Declared In

FMWebSync.h

– setTag:

Sets the tag that identifies the contents of the payload.

- (void)setTag:(NSString *)value

Discussion

Sets the tag that identifies the contents of the payload.

Declared In

FMWebSync.h

– tag

Gets the tag that identifies the contents of the payload.

- (NSString *)tag

Discussion

Gets the tag that identifies the contents of the payload.

Declared In

FMWebSync.h

– toJson

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

- (NSString *)toJson

Discussion

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

Declared In

FMWebSync.h

+ toJsonMultipleWithNotifications:

Serializes a list of notifications to JSON.

+ (NSString *)toJsonMultipleWithNotifications:(NSMutableArray *)notifications

Parameters

name="notifications">A

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

Discussion

Serializes a list of notifications to JSON.

Declared In

FMWebSync.h

+ toJsonWithNotification:

Serializes a notification to JSON.

+ (NSString *)toJsonWithNotification:(FMWebSyncNotification *)notification

Parameters

name="notification">A

notification to serialize. A JSON-serialized notification.

Discussion

Serializes a notification to JSON.

Declared In

FMWebSync.h

+ toMessagesWithNotifications:

Converts a set of Notifications to their Message formats.

+ (NSMutableArray *)toMessagesWithNotifications:(NSMutableArray *)notifications

Parameters

name="notifications">The

notifications. The messages.

Discussion

Converts a set of Notifications to their Message formats.

Declared In

FMWebSync.h

+ toMessageWithNotification:

Converts a Notification to its Message format.

+ (FMWebSyncMessage *)toMessageWithNotification:(FMWebSyncNotification *)notification

Parameters

name="notification">The

notification. The message.

Discussion

Converts a Notification to its Message format.

Declared In

FMWebSync.h