HyphenateChatSDK  3.8.3.1
Instance Methods | Properties | List of all members
EMCmdMessageBody Class Reference

#import <EMCmdMessageBody.h>

Inheritance diagram for EMCmdMessageBody:
EMMessageBody

Instance Methods

(instancetype) - initWithAction:
 

Properties

NSString * action
 
NSArray * params
 
BOOL isDeliverOnlineOnly
 
- Properties inherited from EMMessageBody
EMMessageBodyType type
 

Detailed Description

@header EMCmdMessageBody.h @abstract Command message body

Author
Hyphenate
Version
3.00

Command message body

Method Documentation

◆ initWithAction:

- (instancetype) initWithAction: (NSString *)  aAction

Construct command message body Developer self-defined command string that can be used for specifing custom action/command. ex. Share a location: mark the action with "location" string, then the parser knows that it's a command message about location sharing and find more attributes stored in extension property .ext. ex. Self-destructive message like Snapchat: mark the action ”selfDestructive“ and add the messageId of the message to be destruct and expiration time as part of .ext

Parameters
aActionSelf-defined command string content
Returns
Instance of command message body

Property Documentation

◆ action

- (NSString*) action
readwritenonatomiccopy

Command content

◆ isDeliverOnlineOnly

- (BOOL) isDeliverOnlineOnly
readwritenonatomicassign

If this cmd msg is deliver to the online users only, default is NO.

◆ params

- (NSArray*) params
readwritenonatomiccopy

Command parameters, only compatible with old sdk versions. For SDK version 3.0+, use EMMessage's ext property instead


The documentation for this class was generated from the following file: