BlackBerry Spark Communications Services for iOS  1.11.0
BBMChat.h File Reference

Classes

class  BBMChat
 

Enumerations

enum  BBMChatInvitePolicy { kBBMChat_InvitePolicy_Unspecified, kBBMChat_InvitePolicyAdminsOnly, kBBMChat_InvitePolicyParticipantsOnly }
 
enum  BBMChatKeyState { kBBMChat_KeyState_Unspecified, kBBMChat_KeyStateExport, kBBMChat_KeyStateImport, kBBMChat_KeyStateSynced }
 
enum  BBMChatState {
  kBBMChat_State_Unspecified, kBBMChat_StateDefunct, kBBMChat_StateReady, kBBMChat_StateRestore,
  kBBMChat_StateWaiting
}
 

Enumeration Type Documentation

◆ BBMChatInvitePolicy

Enumerator
kBBMChat_InvitePolicyAdminsOnly 

Only chat admins may invite participants to the chat.

kBBMChat_InvitePolicyParticipantsOnly 

Only chat participants may invite participants to the chat.

◆ BBMChatKeyState

Enumerator
kBBMChat_KeyStateExport 

The chat's key needs to be exported from bbmcore and placed into external storage. When using Cloud Key Storage, your application must perform this export using 'chatKeyExport'. When using the BlackBerry Key Management Service (KMS), bbmcore will do this automatically.

kBBMChat_KeyStateImport 

The chat's key needs to be retrieved from external storage and imported into bbmcore. When using Cloud Key Storage, your application must perform this import using 'chatKeysImport'. When using the BlackBerry Key Management Service (KMS), bbmcore will do this automatically.

kBBMChat_KeyStateSynced 

The chat's key is synced.

◆ BBMChatState

Enumerator
kBBMChat_StateDefunct 

The BlackBerry Infrastructure has notified bbmcore that this chat is no longer available. This state exists so the user knows why their previously functional chat is no longer functional, and gives the user a chance to consume the content of the chat until they remove it. bbmcore will not send or receive any further messages for a chat in this state. bbmcore does not automatically remove defunct chats. Your application can remove it explicitly with 'chatLeave' (and in some cases, with 'chatHide').

kBBMChat_StateReady 

The chat is ready to send and receive messages. Any delays in sending or receiving messages in this state are due only to BlackBerry Infrastructure connectivity and availability.

kBBMChat_StateRestore 

The chat is currently restoring its message history. Content added via 'chatMessageSend' will be queued to be sent and will still be added to the 'chatMessage' list and reported via 'listAdd'. Note that no 'listAdd' event occurs for a 'chatMessage' restored or received while a chat is in this state. When the chat 'state' becomes 'Ready', your application must ask bbmcore for any existing messages.

kBBMChat_StateWaiting 

The chat is not ready to send or receive messages because it is waiting on an unspecified "slow" activity . Content added via 'chatMessageSend' will be queued to be sent and will still be added to the 'chatMessage' list and reported via 'listAdd'. Note that no 'listAdd' event occurs for a 'chatMessage' restored or received while a chat is in this state because such activity cannot happen while the chat lacks keys.