Public 成员函数
	getUsersBlockedFromSendMsgToUser ($username)
	获取用户黑名单更多...

	blockUserSendMsgToUser ($username, $usernames=array())
	添加用户黑名单更多...

	unblockUserSendMsgToUser ($username, $blocked_username)
	移除用户黑名单更多...

	blockUserLogin ($username)
	账号封禁更多...

	unblockUserLogin ($username)
	账号解禁更多...

	blockUserSendMsg ($username, $chatMuteDuration=-1, $groupchatMuteDuration=-1, $chatroomMuteDuration=-1)
	设置用户全局禁言更多...

	unblockUserSendMsg ($username)
	解除用户全局禁言更多...

	getUserBlocked ($username)
	查询单个用户 ID 全局禁言更多...

	getAppBlocked ($pageSize=10, $pageNum=1)
	查询APPKEY的用户禁言更多...

	getUsersBlockedJoinGroup ($groupId)
	查询群组黑名单更多...

	blockUserJoinGroup ($groupId, $username)
	添加单个用户至群组黑名单更多...

	blockUsersJoinGroup ($groupId, $usernames)
	批量添加用户至群组黑名单更多...

	unblockUserJoinGroup ($groupId, $username)
	从群组黑名单移除单个用户更多...

	unblockUsersJoinGroup ($groupId, $usernames)
	从群组黑名单批量移除用户更多...

	blockUserSendMsgToGroup ($groupId, $usernames, $mute_duration=-1)
	添加群组禁言更多...

	unblockUserSendMsgToGroup ($groupId, $usernames)
	解除群组成员禁言更多...

	getUsersBlockedSendMsgToGroup ($groupId)
	获取禁言列表更多...

	blockAllUserSendMsgToGroup ($groupId, $mute_duration=-1)
	禁言群组全体成员更多...

	unblockAllUserSendMsgToGroup ($groupId)
	解除群组全员禁言更多...

	getUsersBlockedJoinRoom ($roomId)
	查询聊天室黑名单更多...

	blockUserJoinRoom ($roomId, $username)
	添加单个用户至聊天室黑名单更多...

	blockUsersJoinRoom ($roomId, $usernames)
	批量添加用户至聊天室黑名单更多...

	unblockUserJoinRoom ($roomId, $username)
	从聊天室黑名单移除单个用户更多...

	unblockUsersJoinRoom ($roomId, $usernames)
	从聊天室黑名单批量移除用户更多...

	blockUserSendMsgToRoom ($roomId, $usernames, $mute_duration=-1)
	禁言聊天室成员更多...

	unblockUserSendMsgToRoom ($roomId, $usernames)
	解除聊天室禁言成员更多...

	getUsersBlockedSendMsgToRoom ($roomId)
	获取聊天室禁言列表更多...

	blockAllUserSendMsgToRoom ($roomId, $mute_duration=-1)
	禁言聊天室全体成员更多...

	unblockAllUserSendMsgToRoom ($roomId)
	解除聊天室全员禁言更多...

详细描述

Block 用于限制访问(将用户加入黑名单、群组/聊天室禁言等)

成员函数说明

◆ blockAllUserSendMsgToGroup()

Easemob\Block::blockAllUserSendMsgToGroup	(	$groupId,
		$mute_duration = `-1`
	)

禁言群组全体成员

对所有群组成员一键禁言，即将群组的所有成员均加入禁言列表。设置群组全员禁言后，仅群组白名单中的用户可在群组内发消息

参数

string	$groupId	群组 ID
int	$mute_duration	禁言时长，单位为毫秒。

返回: boolean|array 成功或者错误

◆ blockAllUserSendMsgToRoom()

Easemob\Block::blockAllUserSendMsgToRoom	(	$roomId,
		$mute_duration = `-1`
	)

禁言聊天室全体成员

对所有聊天室成员一键禁言，即将聊天室的所有成员均加入禁言列表。设置聊天室全员禁言后，仅聊天室白名单中的用户可在聊天室内发消息。

参数

string	$roomId	聊天室 ID
int	$mute_duration	禁言时长，单位为毫秒。

返回: boolean|array 成功或者错误

◆ blockUserJoinGroup()

Easemob\Block::blockUserJoinGroup	(	$groupId,
		$username
	)

添加单个用户至群组黑名单

添加一个用户进入一个群组的黑名单。群主无法被加入群组的黑名单。

用户进入群组黑名单后，会收到消息：You are kicked out of the group xxx。之后，该用户查看不到该群组的信息，也收不到该群组的消息。

参数

string	$groupId	群组 ID
string	$username	要添加的 IM 用户名

返回: boolean|array 成功或者错误

◆ blockUserJoinRoom()

Easemob\Block::blockUserJoinRoom	(	$roomId,
		$username
	)

添加单个用户至聊天室黑名单

添加一个用户进入一个聊天室的黑名单。聊天室所有者无法被加入聊天室的黑名单。

用户进入聊天室黑名单后，会收到消息：“You are kicked out of the chatroom xxx”。之后，该用户无法查看和收发该聊天室的信息。

参数

string	$roomId	聊天室 ID
string	$username	要添加的 IM 用户名

返回: boolean|array 成功或者错误

◆ blockUserLogin()

Easemob\Block::blockUserLogin ( $username )

账号封禁

用户若被禁用将立即下线并无法登录，直到被解禁后才能恢复登录。常用在对异常用户的即时处理场景使用。

参数

string $username 要封禁的用户名

返回: boolean|array 成功或者错误

◆ blockUserSendMsg()

Easemob\Block::blockUserSendMsg	(	$username,
		$chatMuteDuration = `-1`,
		$groupchatMuteDuration = `-1`,
		$chatroomMuteDuration = `-1`
	)

设置用户全局禁言

设置单个用户 ID 的单聊、群组、聊天室消息全局禁言。

参数

string	$username	用户名
int	$chatMuteDuration	单聊消息禁言时间，单位为秒，非负整数，最大值为 2147483647，`0` 表示取消该帐号的单聊消息禁言，`-1` 表示该帐号被设置永久禁言，其它值表示该帐号的具体禁言时间，负值为非法值。
int	$groupchatMuteDuration	群组消息禁言时间，单位为秒，规则同上。
int	$chatroomMuteDuration	聊天室消息禁言时间，单位为秒，规则同上。

返回: boolean|array 成功或者错误

◆ blockUserSendMsgToGroup()

Easemob\Block::blockUserSendMsgToGroup	(	$groupId,
		$usernames,
		$mute_duration = `-1`
	)

添加群组禁言

对指定群成员禁言。群成员被禁言后，将无法在群中发送消息。

参数

string	$groupId	群组 ID
array	$usernames	要被添加禁言的用户 ID 数组
int	$mute_duration	禁言时长，单位为毫秒。

返回: boolean|array 成功或者错误

◆ blockUserSendMsgToRoom()

Easemob\Block::blockUserSendMsgToRoom	(	$roomId,
		$usernames,
		$mute_duration = `-1`
	)

禁言聊天室成员

将用户禁言。用户被禁言后，将无法在聊天室中发送消息。

参数

string	$roomId	聊天室 ID
array	$usernames	要被添加禁言的用户 ID 数组
int	$mute_duration	禁言的时间，单位毫秒，如果是“-1”代表永久（实际的到期时间为固定时间戳4638873600000，即2117-01-01 00:00:00）

返回: boolean|array 成功或者错误

◆ blockUserSendMsgToUser()

Easemob\Block::blockUserSendMsgToUser	(	$username,
		$usernames = `array()`
	)

添加用户黑名单

向用户的黑名单列表中添加一个或者多个用户，黑名单中的用户无法给该用户发送消息，每个用户的黑名单人数上限为 500。

参数

string	$username	要添加黑名单的用户名
array	$usernames	需要加入到黑名单中的用户名，以数组方式提交

返回: boolean|array 成功或者错误

◆ blockUsersJoinGroup()

Easemob\Block::blockUsersJoinGroup	(	$groupId,
		$usernames
	)

批量添加用户至群组黑名单

将多个用户添加一个群组的黑名单。你一次最多可以添加 60 个用户至群组黑名单。群主无法被加入群组的黑名单。

用户进入群组黑名单后，会收到消息：You are kicked out of the group xxx。之后，该用户查看不到该群组的信息，也收不到该群组的消息。

参数

string	$groupId	群组 ID
array	$usernames	要添加的 IM 用户名数组

返回: boolean|array 成功或者错误

◆ blockUsersJoinRoom()

Easemob\Block::blockUsersJoinRoom	(	$roomId,
		$usernames
	)

批量添加用户至聊天室黑名单

将多个用户加入一个聊天室的黑名单。你一次最多可以添加 60 个用户至聊天室黑名单。聊天室所有者无法被加入聊天室的黑名单。

用户进入聊天室黑名单后，会收到消息：“You are kicked out of the chatroom xxx”。之后，这些用户无法查看和收发该聊天室的信息。

参数

string	$roomId	聊天室 ID
array	$usernames	要添加的 IM 用户名数组

返回: boolean|array 成功或者错误

◆ getAppBlocked()

Easemob\Block::getAppBlocked	(	$pageSize = `10`,
		$pageNum = `1`
	)

查询APPKEY的用户禁言

查询 App Key 下的用户禁言剩余时间的集合。

参数

int	$pageSize	请求查询每页显示的禁言用户的数量，默认取 10 条
int	$pageNum	请求查询的页码，默认取第 1 页

返回: array 用户禁言信息或者错误

◆ getUserBlocked()

Easemob\Block::getUserBlocked ( $username )

查询单个用户 ID 全局禁言

查询单个用户的单聊/群聊/聊天室消息禁言。

参数

string $username 查询禁言信息的用户名

返回: array 用户全局禁言信息或者错误

◆ getUsersBlockedFromSendMsgToUser()

Easemob\Block::getUsersBlockedFromSendMsgToUser ( $username )

获取用户黑名单

参数

string $username 要获取黑名单的用户

返回: array 黑名单用户名列表或者错误

◆ getUsersBlockedJoinGroup()

Easemob\Block::getUsersBlockedJoinGroup ( $groupId )

查询群组黑名单

查询一个群组黑名单中的用户列表。位于黑名单中的用户查看不到该群组的信息，也无法收到该群组的消息。

参数

string $groupId 群组 ID

返回: array 群组黑名单信息或者错误

◆ getUsersBlockedJoinRoom()

Easemob\Block::getUsersBlockedJoinRoom ( $roomId )

查询聊天室黑名单

查询一个聊天室黑名单中的用户列表。黑名单中的用户无法查看或收到该聊天室的信息。

参数

string $roomId 聊天室 ID

返回: array 聊天室黑名单信息或者错误

◆ getUsersBlockedSendMsgToGroup()

Easemob\Block::getUsersBlockedSendMsgToGroup ( $groupId )

获取禁言列表

获取当前群组的禁言用户列表。

参数

string $groupId 群组 ID

返回: array 禁言列表信息或者错误

◆ getUsersBlockedSendMsgToRoom()

Easemob\Block::getUsersBlockedSendMsgToRoom ( $roomId )

获取聊天室禁言列表

参数

string $roomId 聊天室 ID

返回: array 禁言列表信息或者错误

◆ unblockAllUserSendMsgToGroup()

Easemob\Block::unblockAllUserSendMsgToGroup ( $groupId )

解除群组全员禁言

一键取消对群组全体成员的禁言。移除后，群成员可以在群组中正常发送消息。

参数

string $groupId 群组 ID

返回: boolean|array 成功或者错误

◆ unblockAllUserSendMsgToRoom()

Easemob\Block::unblockAllUserSendMsgToRoom ( $roomId )

解除聊天室全员禁言

一键取消对聊天室全体成员的禁言。移除后，聊天室成员可以在聊天室中正常发送消息。

参数

string $roomId 聊天室 ID

返回: boolean|array 成功或者错误

◆ unblockUserJoinGroup()

Easemob\Block::unblockUserJoinGroup	(	$groupId,
		$username
	)

从群组黑名单移除单个用户

将指定用户移出群组黑名单。对于群组黑名单中的用户，如果需要将其再次加入群组，需要先将其从群组黑名单中移除。

参数

string	$groupId	群组 ID
string	$username	要移除的用户名

返回: boolean|array 成功或者错误

◆ unblockUserJoinRoom()

Easemob\Block::unblockUserJoinRoom	(	$roomId,
		$username
	)

从聊天室黑名单移除单个用户

将指定用户移出聊天室黑名单。对于聊天室黑名单中的用户，如果需要将其再次加入聊天室，需要先将其从聊天室黑名单中移除。

参数

string	$roomId	聊天室 ID
string	$username	要添加的 IM 用户名

返回: boolean|array 成功或者错误

◆ unblockUserLogin()

Easemob\Block::unblockUserLogin ( $username )

账号解禁

用户若被禁用将立即下线并无法登录，直到被解禁后才能恢复登录。常用在对异常用户的即时处理场景使用。

参数

string $username 要解禁的用户名

返回: boolean|array 成功或者错误

◆ unblockUserSendMsg()

Easemob\Block::unblockUserSendMsg ( $username )

解除用户全局禁言

参数

string $username 解除禁言的用户名

返回: boolean|array 成功或者错误

◆ unblockUserSendMsgToGroup()

Easemob\Block::unblockUserSendMsgToGroup	(	$groupId,
		$usernames
	)

解除群组成员禁言

将一个或多个群成员移除禁言列表。移除后，群成员可以在群组中正常发送消息。

参数

string	$groupId	群组 ID
array	$usernames	要移除禁言的用户 ID 数组

返回: boolean|array 成功或者错误

◆ unblockUserSendMsgToRoom()

Easemob\Block::unblockUserSendMsgToRoom	(	$roomId,
		$usernames
	)

解除聊天室禁言成员

将用户从禁言列表中移除，可以移除多个 member。移除后，用户可以正常在聊天室中发送消息。

参数

string	$roomId	聊天室 ID
array	$usernames	要移除禁言的用户 ID 数组

返回: boolean|array 成功或者错误

◆ unblockUserSendMsgToUser()

Easemob\Block::unblockUserSendMsgToUser	(	$username,
		$blocked_username
	)

移除用户黑名单

从用户的黑名单中移除用户。将用户从黑名单移除后，恢复到好友，或者未添加好友的用户关系。可以正常的进行消息收发。

参数

string	$username	要移除黑名单的用户名
string	$friend_username	好友用户名

返回: boolean|array 成功或者错误

◆ unblockUsersJoinGroup()

Easemob\Block::unblockUsersJoinGroup	(	$groupId,
		$usernames
	)

从群组黑名单批量移除用户

将多名指定用户从群组黑名单中移除。对于群组黑名单中的用户，如果需要将其再次加入群组，需要先将其从群组黑名单中移除。

参数

string	$groupId	群组 ID
array	$usernames	要添加的 IM 用户名数组

返回: boolean|array 成功或者错误

◆ unblockUsersJoinRoom()

Easemob\Block::unblockUsersJoinRoom	(	$roomId,
		$usernames
	)

从聊天室黑名单批量移除用户

将多名指定用户从聊天室黑名单中移除。你每次最多可移除 60 个用户。对于聊天室黑名单中的用户，如果需要将其再次加入聊天室，需要先将其从聊天室黑名单中移除。

参数

string	$roomId	聊天室 ID
array	$usernames	要添加的 IM 用户名数组

返回: boolean|array 成功或者错误

Public 成员函数

详细描述

成员函数说明

◆ blockAllUserSendMsgToGroup()

◆ blockAllUserSendMsgToRoom()

◆ blockUserJoinGroup()

◆ blockUserJoinRoom()

◆ blockUserLogin()

◆ blockUserSendMsg()

◆ blockUserSendMsgToGroup()

◆ blockUserSendMsgToRoom()

◆ blockUserSendMsgToUser()

◆ blockUsersJoinGroup()

◆ blockUsersJoinRoom()

◆ getAppBlocked()

◆ getUserBlocked()

◆ getUsersBlockedFromSendMsgToUser()

◆ getUsersBlockedJoinGroup()

◆ getUsersBlockedJoinRoom()

◆ getUsersBlockedSendMsgToGroup()

◆ getUsersBlockedSendMsgToRoom()

◆ unblockAllUserSendMsgToGroup()

◆ unblockAllUserSendMsgToRoom()

◆ unblockUserJoinGroup()

◆ unblockUserJoinRoom()

◆ unblockUserLogin()

◆ unblockUserSendMsg()

◆ unblockUserSendMsgToGroup()

◆ unblockUserSendMsgToRoom()

◆ unblockUserSendMsgToUser()

◆ unblockUsersJoinGroup()

◆ unblockUsersJoinRoom()