BlackBerry Spark Communications Services for iOS  1.11.0
BBMChatStartMessage Class Reference
Inheritance diagram for BBMChatStartMessage:
BBMJSONMessage

Instance Methods

(id) - initWithInvitees:
 
- Instance Methods inherited from BBMJSONMessage
(NSString *) - requestData
 
(NSDictionary *) - requestDict
 

Properties

NSString * cookie
 
NSArray * invitees
 
NSDictionary * data
 
BBMChatStartMessageInvitePolicy invitePolicy
 
BOOL isOneToOne
 
NSDictionary * localData
 
NSDictionary * privateData
 
NSString * subject
 

Detailed Description

Represents the chatStart protocol message.

This message requests that a new chat be started. When successful, a 'listAdd' will be emitted for the new 'chat' element. Otherwise, bbmcore will respond with a 'chatStartFailed' message.

If 'isOneToOne' is true and a 1:1 chat already exists for the invitee, bbmcore will respond with a 'chatStartFailed' with a reason of 'AlreadyExists' and the 'chatId' of that existing chat.

Since
R2

Property Documentation

◆ cookie

- (NSString*) cookie
readnonatomicstrong

An opaque string generated by your application that will be included in the resulting 'listAdd' or 'chatStartFailed' message.

Since
R2

◆ data

- (NSDictionary*) data
readwritenonatomicstrong

This field contains opaque data managed by your application.This data can be read or written by any participant. Concurrent writes are resolved in a way that all participants will eventually see the same steady-state outcome.This field is suitable for shared chat metadata that changes infrequently such a chat avatar URL, the identifiers of external resources associated with the chat, or a per-chat setting shared by all participants. Data that changes frequently should be sent to all participants via the 'data' field of 'chatMessage' instead.The the 'data', encoded as JSON in UTF-8, must not exceed 71680 bytes (70 KB).

Since
R6

◆ invitees

- (NSArray*) invitees
readnonatomicstrong

Holds the list of invitees to invite to the chat. When 'isOneToOne' is true, this list must contain exactly one entry. Otherwise, it may contain zero or more entries.

Since
R2

◆ invitePolicy

- (BBMChatStartMessageInvitePolicy) invitePolicy
readwritenonatomicassign

The policy that controls who may invite participants to the chat. This only applies when the 'isOneToOne' field is absent or false.

Since
R4

◆ isOneToOne

- (BOOL) isOneToOne
readwritenonatomicassign

When true, the chat is the singular 1:1 chat between the local user and the other party. bbmcore ensures that only one such non-Defunct chat per remote party will exist at a time. Otherwise, the chat is a multi-party chat, even if there are fewer than two remote parties.

Since
R3

◆ localData

- (NSDictionary*) localData
readwritenonatomicstrong

This field contains opaque local-only data that is associated with this chat and managed by your application. This data is stored locally on this endpoint only.

Since
R6

◆ privateData

- (NSDictionary*) privateData
readwritenonatomicstrong

This field contains opaque data managed by your application.This data can be read or written only by endpoints belonging to the local user's identity. Concurrent writes are resolved in a way that all endpoints will eventually see the same steady-state outcome.This field is suitable for chat metadata that changes infrequently and is private to the local user's identity but needs to be known by all the local user's endpoints.The 'privateData', encoded as JSON in UTF-8, must not exceed 71680 bytes (70 KB).

Since
R7

◆ subject

- (NSString*) subject
readwritenonatomicstrong

The subject of the chat. This field has a maximum size of 128 code points. When omitted, this defaults to the empty string.

Since
R2