userManage
userManage
- userManage
- .getToken() ⇒
string - .getUid() ⇒
number - .getAppid() ⇒
string - .getConversationList() ⇒
Array.<ConversationItem> - .getDeviceSN() ⇒
number - .asyncBindDeviceToken(param) ⇒
Promise.<boolean> - .asyncUnbindDeviceToken(param) ⇒
Promise.<boolean> - .asyncRegister(opt) ⇒
Promise.<UserSettings> - .asyncUpdateAvatar(params) ⇒
Promise.<boolean> - .asyncUpdateNickName(params) ⇒
Promise.<boolean> - .asyncGetProfile() ⇒
Promise.<UserProfile> - .asyncUpdateProfile(params) ⇒
Promise.<boolean> - .asyncGetSettings() ⇒
Promise.<UserSettings> - .asyncUpdateSettings(settings) ⇒
Promise.<boolean>
- .getToken() ⇒
userManage.getToken() ⇒ string
获取登录用户的token
Kind: static method of userManage
Returns: string - 用户的token
userManage.getUid() ⇒ number
获取登录用户的uid
Kind: static method of userManage
Returns: number - 用户ID
userManage.getAppid() ⇒ string
获取appid
Kind: static method of userManage
Returns: string - APP ID
userManage.getConversationList() ⇒ Array.<ConversationItem>
获取最近会话列表
Kind: static method of userManage
userManage.getDeviceSN() ⇒ number
获取设备序号
Kind: static method of userManage
Returns: number - 设备序号
userManage.asyncBindDeviceToken(param) ⇒ Promise.<boolean>
绑定推送设备
Kind: static method of userManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| param | object |
绑定请求 |
| param.device_sn | number |
设备序号 |
| param.notifier_name | string |
证书名称，即在蓝莺IM控制台内上传证书时候设置的名称。 |
| param.device_token | string |
推送设备Token |
userManage.asyncUnbindDeviceToken(param) ⇒ Promise.<boolean>
解绑推送设备
Kind: static method of userManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| param | object |
解绑请求 |
| param.deviceSn | number |
设备序号 |
userManage.asyncRegister(opt) ⇒ Promise.<UserSettings>
用户注册
Kind: static method of userManage
Returns: Promise.<UserSettings> - 用户设置
| Param | Type | Description |
|---|---|---|
| opt | object |
用户信息 |
| opt.username | string |
用户名 |
| opt.password | string |
密码 |
userManage.asyncUpdateAvatar(params) ⇒ Promise.<boolean>
更新头像
Kind: static method of userManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| params | object |
参数 |
| params.avatar | string |
头像 url |
userManage.asyncUpdateNickName(params) ⇒ Promise.<boolean>
更新昵称
Kind: static method of userManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| params | object |
参数 |
| params.nick_name | string |
昵称 |
userManage.asyncGetProfile() ⇒ Promise.<UserProfile>
获取用户profile
Kind: static method of userManage
Returns: Promise.<UserProfile> - 用户信息
userManage.asyncUpdateProfile(params) ⇒ Promise.<boolean>
更新用户profile
Kind: static method of userManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| params | object |
|
| params.description | string |
描述信息 |
| params.nick_name | string |
昵称 |
| params.private_info | string |
私有信息，仅自己可见 |
| params.public_info | string |
公开信息，好友和陌生人可见 |
userManage.asyncGetSettings() ⇒ Promise.<UserSettings>
获取用户设置信息
Kind: static method of userManage
Returns: Promise.<UserSettings> - 用户信息
userManage.asyncUpdateSettings(settings) ⇒ Promise.<boolean>
修改用户设置
Kind: static method of userManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| settings | UserSettings |
更新的设置 |