Easemob\Room类 参考

Public 成员函数
	listRooms ($limit=10, $cursor='')
	获取 app 中所有的聊天室（分页） 更多...
	listAllRooms ()
	获取 app 中所有的聊天室 更多...
	listRoomsUserJoined ($username, $pageSize=10, $pageNum=1)
	获取用户加入的聊天室（分页） 更多...
	listAllRoomsUserJoined ($username)
	获取用户加入的聊天室 更多...
	getRoom ($roomId)
	获取聊天室详情 更多...
	createRoom ($name, $description, $owner, $members=array(), $maxusers=0)
	创建聊天室 更多...
	updateRoom ($data)
	修改聊天室信息 更多...
	destroyRoom ($roomId)
	删除聊天室 更多...
	getRoomAnnouncement ($roomId)
	获取聊天室公告 更多...
	updateRoomAnnouncement ($roomId, $announcement)
	修改聊天室公告 更多...
	listRoomMembers ($roomId, $pageSize=10, $pageNum=1)
	分页获取聊天室成员 更多...
	listRoomMembersAll ($roomId)
	获取聊天室所有成员 更多...
	addRoomMember ($roomId, $username)
	添加单个聊天室成员 更多...
	addRoomMembers ($roomId, $usernames)
	批量添加聊天室成员 更多...
	removeRoomMember ($roomId, $username)
	删除单个聊天室成员 更多...
	removeRoomMembers ($roomId, $usernames)
	批量删除聊天室成员 更多...
	listRoomAdminsAll ($roomId)
	获取聊天室管理员列表 更多...
	promoteRoomAdmin ($roomId, $newadmin)
	添加聊天室管理员 更多...
	demoteRoomAdmin ($roomId, $oldadmin)
	移除聊天室管理员 更多...
	listRoomSuperAdmins ($pageSize=10, $pageNum=1)
	分页获取聊天室超级管理员列表 更多...
	promoteRoomSuperAdmin ($superadmin)
	添加超级管理员 更多...
	demoteRoomSuperAdmin ($superadmin)
	撤销超级管理员 更多...

详细描述

Room 用于管理聊天室

成员函数说明

addRoomMember()

Easemob\Room::addRoomMember	(		$roomId,
			$username
	)

添加单个聊天室成员

一次给聊天室添加一个成员，不能重复添加同一个成员。如果用户已经是聊天室成员，将添加失败，并返回错误。

参数

string	$roomId	聊天室 ID
string	$username	环信用户 ID

返回

boolean|array 成功或者错误

addRoomMembers()

Easemob\Room::addRoomMembers	(		$roomId,
			$usernames
	)

批量添加聊天室成员

向聊天室添加多位用户，一次性最多可添加 60 位用户。

参数

string	$roomId	聊天室 ID
array	$usernames	环信用户 ID 数组

返回

boolean|array 成功或者错误

createRoom()

Easemob\Room::createRoom	(		$name,
			$description,
			$owner,
			$members = array(),
			$maxusers = 0
	)

创建聊天室

创建一个聊天室，并设置聊天室名称、聊天室描述、公开聊天室/私有聊天室属性、聊天室成员最大人数（包括管理员）、加入公开聊天室是否需要批准、管理员、以及聊天室成员。

参数

array	$name	聊天聊天室名称
string	$description	聊天室描述
string	$owner	聊天室的管理员
array	$members	聊天室成员，此属性为可选的，但是如果加了此项，数组元素至少一个
int	$maxusers	聊天室成员最大数（包括聊天室所有者），值为数值类型。

返回

string|array 创建的聊天室 id 或者错误

demoteRoomAdmin()

Easemob\Room::demoteRoomAdmin	(		$roomId,
			$oldadmin
	)

移除聊天室管理员

将用户的角色从聊天室管理员降为普通聊天室成员。

参数

string	$roomId	聊天室 ID
string	$oldadmin	移除的管理员用户 ID

返回

boolean|array 成功或者错误

demoteRoomSuperAdmin()

Easemob\Room::demoteRoomSuperAdmin

(

$superadmin

)

撤销超级管理员

参数

string

$superadmin

需要移除的 IM 用户名

返回

boolean|array 成功或者错误

撤销超级管理员

参数

string

$superadmin

User name

返回

boolean|array Success or error

destroyRoom()

Easemob\Room::destroyRoom

(

$roomId

)

删除聊天室

删除单个聊天室。如果被删除的聊天室不存在，会返回错误。

参数

string

$roomId

聊天室 ID

返回

boolean|array 成功或者错误

getRoom()

Easemob\Room::getRoom

(

$roomId

)

获取聊天室详情

可以获取一个或多个聊天室的详情。当获取多个聊天室的详情时，可以直接填写多个 chatroom_id 并用 “,” 隔开，一次调用最多输入 100 个聊天室 ID，会返回所有存在的聊天室的详情，对于不存在的聊天室，response body 内返回 “chatroom id doesn’t exist”。

参数

string

$roomId

聊天室 ID，多个之间用 “,” 分隔

返回

array 聊天室详情或者错误

getRoomAnnouncement()

Easemob\Room::getRoomAnnouncement

(

$roomId

)

获取聊天室公告

获取指定聊天室 ID 的聊天室公告。

参数

string

$roomId

聊天室 id

返回

array 公告信息或者错误

listAllRooms()

Easemob\Room::listAllRooms

(

)

获取 app 中所有的聊天室

返回

array 聊天室列表信息或者错误

listAllRoomsUserJoined()

Easemob\Room::listAllRoomsUserJoined

(

$username

)

获取用户加入的聊天室

根据用户名称获取该用户加入的全部聊天室

参数

string

$username

用户名

返回

array 用户加入的聊天室列表或者错误

listRoomAdminsAll()

Easemob\Room::listRoomAdminsAll

(

$roomId

)

获取聊天室管理员列表

参数

string

$roomId

聊天室 ID

返回

array 聊天室管理员列表信息或者错误

listRoomMembers()

Easemob\Room::listRoomMembers	(		$roomId,
			$pageSize = 10,
			$pageNum = 1
	)

分页获取聊天室成员

参数

string	$roomId	聊天室 ID
int	$pageSize	每页获取的群组数量，默认取 10 条
int	$pageNum	当前页码，默认取第 1 页

返回

array 聊天室成员信息或者错误

listRoomMembersAll()

Easemob\Room::listRoomMembersAll

(

$roomId

)

获取聊天室所有成员

参数

string

$roomId

聊天室 ID

返回

array 聊天室成员信息或者错误

listRooms()

Easemob\Room::listRooms	(		$limit = 10,
			$cursor = ''
	)

获取 app 中所有的聊天室（分页）

参数

int	$limit	每页显示的数量，默认取 10 条
string	$cursor	分页游标

返回

array 聊天室列表信息或者错误

listRoomSuperAdmins()

Easemob\Room::listRoomSuperAdmins	(		$pageSize = 10,
			$pageNum = 1
	)

分页获取聊天室超级管理员列表

参数

int	$pageSize	每页获取的数量，默认取 10 条
int	$pageNum	当前页码，默认取第 1 页

返回

array 超级管理员列表信息或者错误

listRoomsUserJoined()

Easemob\Room::listRoomsUserJoined	(		$username,
			$pageSize = 10,
			$pageNum = 1
	)

获取用户加入的聊天室（分页）

根据用户名称获取该用户加入的全部聊天室

参数

string	$username	用户名
int	$pageSize	每页获取的群组数量，默认取 10 条
int	$pageNum	当前页码，默认取第 1 页

返回

array 用户加入的聊天室列表或者错误

promoteRoomAdmin()

Easemob\Room::promoteRoomAdmin	(		$roomId,
			$newadmin
	)

添加聊天室管理员

参数

string	$roomId	聊天室 ID
string	$newadmin	添加的新管理员用户 ID

返回

boolean|array 成功或者错误

promoteRoomSuperAdmin()

Easemob\Room::promoteRoomSuperAdmin

(

$superadmin

)

添加超级管理员

给用户添加聊天室超级管理员身份，一次只能添加一个。

参数

string

$superadmin

添加的用户名称

返回

boolean|array 成功或者错误

removeRoomMember()

Easemob\Room::removeRoomMember	(		$roomId,
			$username
	)

删除单个聊天室成员

从聊天室删除一个成员。如果被删除用户不在聊天室中，或者聊天室不存在，将返回错误。

参数

string	$roomId	聊天室 ID
string	$username	环信用户 ID

返回

boolean|array 成功或者错误

removeRoomMembers()

Easemob\Room::removeRoomMembers	(		$roomId,
			$usernames
	)

批量删除聊天室成员

从聊天室删除多个成员。如果被删除用户不在聊天室中，或者聊天室不存在，将返回错误。

一次最多传 100 个用户 ID。

参数

string	$roomId	聊天室 ID
array	$usernames	环信用户 ID 数组

返回

boolean|array 成功或者错误

updateRoom()

Easemob\Room::updateRoom

(

$data

)

修改聊天室信息

修改成功的数据行会返回 true，失败为 false。请求 body 只接收 name、description、maxusers 三个属性。传其他字段，或者不能修改的字段会抛异常。

参数

array

$data

聊天室信息 name string 类型，聊天室名称，修改时值不能包含斜杠(“/”)。 description string 类型，聊天室描述，修改时值不能包含斜杠(“/”)。 maxusers int 类型，聊天室最大成员数（包括聊天室所有者），值为数值类型。

返回

boolean|array 成功或者错误

updateRoomAnnouncement()

Easemob\Room::updateRoomAnnouncement	(		$roomId,
			$announcement
	)

修改聊天室公告

修改指定聊天室 ID 的聊天室公告。聊天室公告内容不能超过 512 个字符。

参数

string	$roomId	聊天室 ID
string	$announcement	聊天室公告内容

返回

boolean|array 成功或者错误