Easemob\UserMetadata类 参考

Public 成员函数
	setMetadataToUser ($username, $metadata)
	设置用户属性 更多...
	getMetadataFromUser ($username)
	获取用户属性 更多...
	batchGetMetadataFromUser ($targets, $properties)
	批量获取用户属性 更多...
	getUsage ()
	获取用户属性总量大小 更多...
	deleteMetadataFromUser ($username)
	删除用户属性 更多...

详细描述

UserMetadata 用来管理用户属性

成员函数说明

batchGetMetadataFromUser()

Easemob\UserMetadata::batchGetMetadataFromUser	(		$targets,
			$properties
	)

批量获取用户属性

根据指定的用户名列表和属性列表，查询用户属性。如果指定的用户或用户属性不存在，返回空数据 {}。 每次最多指定 100 个用户。

参数

array	$targets	用户名列表，最多 100 个用户名。
array	$properties	属性名列表，查询结果只返回该列表中包含的属性，不在该列表中的属性将被忽略。

返回

array 用户属性（数组键是用户名，数组值是用户对应的属性）或者错误

deleteMetadataFromUser()

Easemob\UserMetadata::deleteMetadataFromUser

(

$username

)

删除用户属性

删除指定用户的所有属性。如果指定的用户或用户属性不存在（可能已删除），也视为删除成功。

参数

string

$username

用户名

返回

boolean|array 成功或者错误

getMetadataFromUser()

Easemob\UserMetadata::getMetadataFromUser

(

$username

)

获取用户属性

获取指定用户的所有用户属性键值对。如果指定的用户或用户属性不存在，返回空数据 {}。

参数

string

$username

要获取属性的用户名

返回

array 用户属性或者错误

getUsage()

Easemob\UserMetadata::getUsage

(

)

获取用户属性总量大小

获取该 app 下所有用户的属性数据大小，单位为 byte。

返回

float|array 用户属性总量大小（单位：byte）或者错误

setMetadataToUser()

Easemob\UserMetadata::setMetadataToUser	(		$username,
			$metadata
	)

设置用户属性

用户属性的内容为一个或多个纯文本键值对，默认单一用户的属性总长不得超过 2 KB，默认一个 app 下所有用户的所有属性总长不得超过 10 GB。

参数

string	$username	要设置属性的用户名
array	$metadata	要设置的属性（键：属性名；值：属性值）

返回

boolean|array 成功或者错误