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

Instance Methods

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

Properties

NSString * chatId
 
unsigned long long messageId
 
BOOL detachFile
 
BOOL detachThumb
 

Detailed Description

Represents the chatMessageDetach protocol message.

Request that bbmcore remove the 'file' and/or 'thumb' attachments locally for a single 'chatMessage'. This message does not change the 'chatMessage' for any other endpoints or identities.

Since
R2

Property Documentation

◆ chatId

- (NSString*) chatId
readnonatomicstrong

The identifier of the chat containing the 'chatMessage'.

Since
R2

◆ detachFile

- (BOOL) detachFile
readwritenonatomicassign

Iff present and true, any 'file' attachment will be deleted from the 'chatMessage' iff the 'fileState' of that message is 'Done'. If the 'fileState' is anything else, no 'file' detachment is performed.After detachment, the 'file' field will no longer be present on the 'chatMessage', and the 'fileState' will be set to 'Available'. Thus, in the case of a completed download or upload, the file attachment can be subsequently downloaded by issuing 'chatMessageFileDownload'.The primary reason to detach an upload is to free storage space for old completed uploads that used a 'filePolicy' of 'Move'.The 'chatMessage' 'tag' does not matter and will not change.

Since
R2

◆ detachThumb

- (BOOL) detachThumb
readwritenonatomicassign

Iff present and true, any 'thumb' attachment will be deleted from the 'chatMessage'. The 'thumb' field will no longer be present on the 'chatMessage'.The 'chatMessage' 'tag' does not matter and will not change.

Since
R2

◆ messageId

- (unsigned long long) messageId
readnonatomicassign

The identifier of the 'chatMessage' within the chat identified by 'chatId'.

Since
R2