外观
注册用户
约 312 字大约 1 分钟
2025-03-25
1. 描述
register()
方法用于向IM服务器注册用户,因注册属于异步操作,所以需要等待注册结果返回。 注意事项:
- 该方法会返回一个
Promise
对象,用于后续逻辑处理; - 只有注册成功后才可以进行发送消息等操作,否则会导致后续操作失败;
- 如果注册过的用户重复注册,注册信息会
覆盖
原来的信息; - 推荐在业务系统登录成功后,向IM服务器注册用户,避免重复注册;
2. 参数
参数名称 | 是否必选 | 类型 | 说明 |
---|---|---|---|
appKey | 是 | String | 应用Key,在开发者中心获取 |
userId | 是 | String | 业务系统中的用户ID,需要保证唯一性 |
name | 是 | String | 用户昵称,用于会话显示 |
avatar | 否 | String | 用户头像地址,用于会话显示 |
gender | 否 | String | 用户性别,可选值:unknown(默认) 、male 、female |
否 | String | 扩展字段,用户邮箱 | |
phone | 否 | String | 扩展字段,用户手机号 |
3. 返回值
返回Promise对象。
4. 示例代码
XBCIM.register({
appKey: 'your_app_key',
userId: 'your_user_id',
name: 'your_user_name',
avatar: 'your_user_avatar',
gender: 'your_user_gender',
email: 'your_user_email',
phone: 'your_user_phone'
}).then(() => {
console.log('注册成功');
}).catch(error => {
console.error('注册失败', error);
});