CmdMessageBody Class Reference

#import <CmdMessageBody.h>

Inheritance diagram for CmdMessageBody:

Instance Methods
(instancetype)	- initWithAction:

Properties
NSString *	action
NSArray *	params
BOOL	isDeliverOnlineOnly
Properties inherited from MessageBody
MessageBodyType	type

Detailed Description

CmdMessageBody.h Command message body object

Author

Hyphenate

Version

3.00

Command message body

Method Documentation

- (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

aAction

Self-defined command string content

Returns

Instance of command message body

Property Documentation

- (NSString*) action

readwritenonatomiccopy

Command content

- (BOOL) isDeliverOnlineOnly

readwritenonatomicassign

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

- (NSArray*) params

readwritenonatomiccopy

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

---

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

• AgoraChat.framework/Headers/CmdMessageBody.h