外观
登录系统
约 227 字小于 1 分钟
2025-03-25
1. 描述
login() 方法用于用户登录IM服务,是一个异步方法,必须在init()方法之后调用。
2. 参数
| 参数名称 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| userId | 是 | String | 业务系统用户ID |
| code | 是 | String | 授权码,推荐业务系统服务端生产,详见授权码获取,授权码有效期为1小时 |
3. 返回值
返回Promise对象,成功时resolve值为{code: 0, msg: '登录成功'},失败时reject值为Error对象。
| 字段 | 类型 | 说明 |
|---|---|---|
| id | Number | 应用ID |
| appKey | String | 应用Key |
| name | String | 应用名称 |
| remark | String | 备注 |
| package | String | 套餐类型 |
| isFriend | Number | 是否开启好友验证,0-否,1-是 |
| isSensitive | Number | 是否开启敏感词过滤,0-否,1-是 |
| packageEndTime | String | 套餐有效期 |
4. 示例代码
const userId = '123456'
const code = 'xxxxxx'
XBCIM.login({ userId, code }).then(() => {
// todo
}).catch(err => {
console.log('err', err)
})