io.agora.chat.CmdMessageBody Class Reference

Inheritance diagram for io.agora.chat.CmdMessageBody:

Public Member Functions
	CmdMessageBody (String action)
String	action ()
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

The command message body.

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

Constructor & Destructor Documentation

CmdMessageBody()

io.agora.chat.CmdMessageBody.CmdMessageBody

(

String

action

)

Creates a command message.

Parameters

action

The command action content.

Member Function Documentation

action()

String io.agora.chat.CmdMessageBody.action

(

)

Gets the command action content.

Returns

The command action content.

deliverOnlineOnly()

void io.agora.chat.CmdMessageBody.deliverOnlineOnly

(

boolean

onlineOnly

)

Sets whether the current cmd msg is only delivered to online users.

Parameters

onlineOnly

Whether to deliver to online users only. (Default)false: The message is delivered to all users. true: The message is delivered to the online users only, so the offline users won't receive the message when they log in later.

isDeliverOnlineOnly()

boolean io.agora.chat.CmdMessageBody.isDeliverOnlineOnly

(

)

Checks whether this cmd message is only delivered to online users.

Returns

- true: Only delivers to online users.

• false: Delivers to all users.

toString()

String io.agora.chat.CmdMessageBody.toString

(

)

Gets and displays the content of the CMD message.

Returns

The content of the action of the CMD message.

Member Data Documentation

CREATOR

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:

• io/agora/chat/CmdMessageBody.java