用户管理
功能简介
ZIM SDK 提供了用户管理功能,支持用户上传自己的个人信息,更新自己的用户名称、头像,以及查询自己的个人信息等。
实现流程
用户扩展字段管理
ZIM SDK 提供了用户信息的扩展字段,用于描述用户的其他相关属性。开发者可以使用扩展字段,通过 updateUserExtendedData 接口,自定义用户的扩展字段。扩展字段可由开发者自行定义其使用方式,SDK 只会将该字段透传,不会做其它处理。
修改扩展字段属性后,用户可以通过 ZIMUserExtendedDataUpdatedResult 收到修改结果。
var extendedData = JSON.stringify({ age: 18, birthdy: '2000-01-01' });
zim.updateUserExtendedData(extendedData)
.then(function ({ extendedData }) {
// 操作成功
})
.catch(function (err) {
// 操作失败
});
修改用户名称
用户名称 userName
,是指用来描述用户昵称的字符串,开发者可以通过 ZIMUserInfo 对象进行配置。ZIM SDK 支持用户在登录后,通过 updateUserName 接口修改自己的用户名称。
修改用户名称后,用户可以通过 ZIMUserNameUpdatedResult 收到修改结果。
// 修改用户名
// userName 是一个最多256字节的字符串,没有特殊字符限制。
var userName = '新名称';
zim.updateUserName(userName)
.then(function ({ userName }) {
// 操作成功
})
.catch(function (err) {
// 操作失败
});
设置用户头像
ZIM SDK 支持用户在登录后,通过 updateUserAvatarUrl 接口设置或修改自己的用户头像。
设置用户头像后,用户可以通过 ZIMUserAvatarUrlUpdatedResult 收到设置结果。
当一名用户修改头像后,其他用户需调用 queryUsersInfo 接口,并将 ZIMUsersInfoQueryConfig 中 isQueryFromServer 参数赋值为 true
重新 查询用户信息,才会获取最新头像。
// URL最大长度为500字节,没有特殊字符限制
var userAvatarUrl = 'https://xxxx';
zim.updateUserAvatarUrl(userAvatarUrl)
.then(function ({ userAvatarUrl }) {
// 操作成功
})
.catch(function (err) {
// 操作失败
});
查询用户信息
用户可以通过 queryUsersInfo 接口,查询指定用户的全量信息,包括用户名称、用户扩展字段。用户头像 URL、用户扩展字段信息,仅在该接口中可以获取到。
查询信息后,用户可以通过 ZIMUsersInfoQueriedResult 收到查询结果。
// 限制:单个 API 调用中的 UserID 查询数量不能超过 10;在 10 秒内,所有 UserID 查询的累计总数不能超过 10。
var userIDs = ['id1', 'id2'];
zim.queryUsersInfo(userIDs, { isQueryFromServer: false })
.then(function ({ userList, errorUserList }) {
// 操作成功
})
.catch(function (err) {
// 操作失败
});