io.agora.chat.CmdMessageBody Class Reference

Inheritance diagram for io.agora.chat.CmdMessageBody:

Public Member Functions
	CmdMessageBody (String action)
	CmdMessageBody (String action, Map< String, String > params)
String	action ()
Map< String, String >	getParams ()
boolean	isDeliverOnlineOnly ()
void	deliverOnlineOnly (boolean onlineOnly)
String	toString ()
int	describeContents ()
void	writeToParcel (Parcel dest, int flags)

Static Public Attributes
static final Parcelable.Creator< CmdMessageBody >	CREATOR

Detailed Description

Command message body

    CmdMessageBody body = new CmdMessageBody("delete", null);

Constructor & Destructor Documentation

io.agora.chat.CmdMessageBody.CmdMessageBody

(

String

action

)

Construct command message

Parameters

action

Command

Member Function Documentation

String io.agora.chat.CmdMessageBody.action

(

)

Get the action

Returns

the action

void io.agora.chat.CmdMessageBody.deliverOnlineOnly

(

boolean

onlineOnly

)

Set whether current cmd msg only deliver to online users. False as default, means deliver to all users

Parameters

onlineOnly

Whether to deliver to online users only

Map<String, String> io.agora.chat.CmdMessageBody.getParams

(

)

Get the params map

Returns

Map

boolean io.agora.chat.CmdMessageBody.isDeliverOnlineOnly

(

)

Check whether this cmd msg is delivered to online users.

Returns

Boolean, return true means only deliver to online user

String io.agora.chat.CmdMessageBody.toString

(

)

Get the action of cmd message

Returns

String

Member Data Documentation

final Parcelable.Creator<CmdMessageBody> io.agora.chat.CmdMessageBody.CREATOR

static

Initial value:

= new Parcelable.Creator<CmdMessageBody>() {
        public CmdMessageBody createFromParcel(Parcel in) {
            return new CmdMessageBody(in);
        }

        public CmdMessageBody[] newArray(int size) {
            return new CmdMessageBody[size];
        }
    }

---

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

• hyphenatechatsdk/src/io/agora/chat/CmdMessageBody.java