PHPSDK
Public 成员函数 | 所有成员列表
Easemob\WhiteList类 参考

Public 成员函数

 getGroupWhiteList ($groupId)
 查询群组白名单 更多...
 
 addUserToGroupWhiteList ($groupId, $username)
 添加单个用户至群组白名单 更多...
 
 addUsersToGroupWhiteList ($groupId, $usernames)
 批量添加用户至群组白名单 更多...
 
 removeUsersFromGroupWhiteList ($groupId, $username)
 将用户移除群组白名单 更多...
 
 getRoomWhiteList ($roomId)
 查询聊天室白名单 更多...
 
 addUserToRoomWhiteList ($roomId, $username)
 添加单个用户至聊天室白名单 更多...
 
 addUsersToRoomWhiteList ($roomId, $usernames)
 批量添加用户至聊天室白名单 更多...
 
 removeUsersFromRoomWhiteList ($roomId, $username)
 将用户移除聊天室白名单 更多...
 

详细描述

WhiteList 用于管理群组、聊天室白名单

成员函数说明

◆ addUsersToGroupWhiteList()

Easemob\WhiteList::addUsersToGroupWhiteList (   $groupId,
  $usernames 
)

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

添加多个用户至群组白名单。你一次最多可添加 60 个用户。用户添加至白名单后在群组全员禁言时仍可以在群组中发送消息。

参数
string$groupId群组 id
array$usernames用户名数组
返回
boolean|array 成功或者错误

◆ addUsersToRoomWhiteList()

Easemob\WhiteList::addUsersToRoomWhiteList (   $roomId,
  $usernames 
)

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

添加多个用户至聊天室白名单。你一次最多可添加 60 个用户。用户添加至聊天室白名单后,在聊天室全员禁言时,仍可以在聊天室中发送消息。

参数
string$roomId聊天室 id
array$usernames用户名数组
返回
boolean|array 成功或者错误

◆ addUserToGroupWhiteList()

Easemob\WhiteList::addUserToGroupWhiteList (   $groupId,
  $username 
)

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

查询一个群组将指定的单个用户添加至群组白名单。用户在添加至群组白名单后,当群组全员被禁言时,仍可以在群组中发送消息。白名单中的用户列表。

参数
string$groupId群组 id
string$username用户名
返回
boolean|array 成功或者错误

◆ addUserToRoomWhiteList()

Easemob\WhiteList::addUserToRoomWhiteList (   $roomId,
  $username 
)

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

将指定的单个用户添加至聊天室白名单。用户添加至聊天室白名单后,当聊天室全员禁言时,仍可以在聊天室中发送消息。

参数
string$roomId聊天室 id
string$username用户名
返回
boolean|array 成功或者错误

◆ getGroupWhiteList()

Easemob\WhiteList::getGroupWhiteList (   $groupId)

查询群组白名单

查询一个群组白名单中的用户列表。

参数
string$groupId群组 id
返回
array 白名单列表或者错误

◆ getRoomWhiteList()

Easemob\WhiteList::getRoomWhiteList (   $roomId)

查询聊天室白名单

查询一个聊天室白名单中的用户列表。

参数
string$roomId聊天室 id
返回
array 白名单列表或者错误

◆ removeUsersFromGroupWhiteList()

Easemob\WhiteList::removeUsersFromGroupWhiteList (   $groupId,
  $username 
)

将用户移除群组白名单

将指定用户从群组白名单中移除。你每次最多可移除 60 个用户。

参数
string$groupId群组 id
string$username用户名,可以以逗号分隔传递多个用户名
返回
boolean|array 成功或者错误

◆ removeUsersFromRoomWhiteList()

Easemob\WhiteList::removeUsersFromRoomWhiteList (   $roomId,
  $username 
)

将用户移除聊天室白名单

将指定用户从聊天室白名单移除。你每次最多可移除 60 个用户。

参数
string$roomId聊天室 id
string$username用户名,可以以逗号分隔传递多个用户名
返回
boolean|array 成功或者错误