Easemob\User类 参考

Public 成员函数
	create ($users)
	注册单个用户 | 批量注册用户 更多...
	get ($username)
	获取单个用户的详细信息 更多...
	listUsers ($limit=10, $cursor='', $activated=true)
	批量获取用户 更多...
	delete ($username)
	删除单个用户 更多...
	batchDelete ($limit=0)
	批量删除用户 更多...
	updateUserPassword ($username, $newpassword)
	修改用户密码 更多...
	isUserOnline ($username)
	获取用户在线状态 更多...
	isUsersOnline ($usernames)
	批量获取用户在线状态 更多...
	forceLogoutAllDevices ($username)
	强制下线 更多...

详细描述

User 用来实现用户体系建立和管理

成员函数说明

batchDelete()

Easemob\User::batchDelete

(

$limit = 0

)

批量删除用户

删除某个 APP 下指定数量的用户账号。

参数

int

$limit

要删除的用户数量，建议这个数值在 100-500 之间，不要过大。需要注意的是，这里只是批量的一次性删除掉 N 个用户，具体删除哪些并没有指定，可以在返回值中查看到哪些用户被删除掉了。如果 $limit 的值小于等于 0，值会按 1 处理

返回

array 被删除的用户信息或者错误

create()

Easemob\User::create

(

$users

)

注册单个用户 | 批量注册用户

参数

array

$users

要注册的用户信息，注册单个用户时传入一维数组，批量注册用户时传入二维数组。 username String 类型，用户名，长度不可超过 64 个字节长度。支持以下字符集： 26 个小写英文字母 a-z； 26 个大写英文字母 A-Z； 10 个数字 0-9； “_”, “-”, “.”。 注意：不区分大小写。同一个 app 下，用户名唯一。 password String 类型，登录密码，长度不可超过 64 个字符长度。 nickname String 类型，昵称（可选），仅用在客户端推送通知栏显示的昵称，并不是用户个人信息的昵称，开发者可自定义该内容。长度不可超过 100 个字符。支持以下字符集： 26 个小写英文字母 a-z； 26 个大写英文字母 A-Z； 10 个数字 0-9； 中文； 特殊字符。

返回

array 注册的用户信息或者错误

delete()

Easemob\User::delete

(

$username

)

删除单个用户

删除一个用户，如果此用户是群组或者聊天室的群主，系统会同时删除这些群组和聊天室。请在操作时进行确认。

参数

string

$username

用户名

返回

boolean|array 成功或失败或者错误

forceLogoutAllDevices()

Easemob\User::forceLogoutAllDevices

(

$username

)

强制下线

强制用户即把用户状态改为离线，用户需要重新登录才能正常使用。

参数

string

$username

要强制下线用户的用户名

返回

boolean|array 成功或者错误

get()

Easemob\User::get

(

$username

)

获取单个用户的详细信息

参数

string

$username

用户名

返回

array 用户信息或者错误

isUserOnline()

Easemob\User::isUserOnline

(

$username

)

获取用户在线状态

参数

string

$username

要获取在线状态的用户名

返回

boolean|array 是否在线（true：在线，false：离线）或者错误

isUsersOnline()

Easemob\User::isUsersOnline

(

$usernames

)

批量获取用户在线状态

批量查看用户的在线状态，最大同时查看100个用户。

参数

array

$usernames

要获取在线状态的用户名数组，最多不能超过100个

返回

array 用户在线状态数组（数组键为用户名，数组值为用户对应的在线状态，true：在线，false：离线）或者错误

listUsers()

Easemob\User::listUsers	(		$limit = 10,
			$cursor = '',
			$activated = true
	)

批量获取用户

参数

int	$limit	获取用户的数量。默认值 10，最大值 100。超过 100 按照 100 返回。
string	$cursor	游标，用于分页显示用户列表。第一次发起批量查询用户请求时无需设置 cursor，请求成功后会获得第一页用户列表。从响应 body 中获取 cursor，并在下一次请求 中传入该 cursor，直到响应 body 中不再有 cursor 字段，则表示已查询到 app 中所有用户。
boolean	$activated	用户是否激活。true：已激活；false：封禁，封禁需要通过解禁接口进行解禁，才能正常登录。

返回

array 分页用户信息或者错误

updateUserPassword()

Easemob\User::updateUserPassword	(		$username,
			$newpassword
	)

修改用户密码

可以修改用户的登录密码，不需要提供原密码。

参数

string	$username	用户名
string	$newpassword	新密码

返回

boolean|array 成功或者错误