io.agora.chat.CmdMessageBody类 参考

类 io.agora.chat.CmdMessageBody 继承关系图:

Public 成员函数
	CmdMessageBody (String action)
String	action ()
boolean	isDeliverOnlineOnly ()
void	deliverOnlineOnly (boolean onlineOnly)
String	toString ()
Public 成员函数 继承自 io.agora.chat.MessageBody
long	operationTime ()
String	operatorId ()
int	operationCount ()

详细描述

命令消息体。

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

构造及析构函数说明

CmdMessageBody()

io.agora.chat.CmdMessageBody.CmdMessageBody

(

String

action

)

创建一个命令消息。

参数

action

命令内容。

成员函数说明

action()

String io.agora.chat.CmdMessageBody.action

(

)

获取 CMD 消息中的命令内容。

返回

CMD 消息中的命令内容。

deliverOnlineOnly()

void io.agora.chat.CmdMessageBody.deliverOnlineOnly

(

boolean

onlineOnly

)

设置当前 CMD 类型消息是否只投递在线用户。

参数

onlineOnly

是否只投递给在线用户。 （默认） false：投递所有用户； true ：只投递在线用户，这样离线用户上线时不会收到该消息。

isDeliverOnlineOnly()

boolean io.agora.chat.CmdMessageBody.isDeliverOnlineOnly

(

)

判断当前 CMD 类型消息是否只投递在线用户。

返回

- true：只投递在线用户。

• false：投递所有用户。

toString()

String io.agora.chat.CmdMessageBody.toString

(

)

展示 CMD 消息的命令。

返回

命令的内容展示。

---

该类的文档由以下文件生成:

• io/agora/chat/CmdMessageBody.java