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> - .asyncUserChangePassword(params) ⇒
Promise.<boolean> - .asyncGetProfile() ⇒
Promise.<UserProfile> - .asyncUpdateProfile(params) ⇒
Promise.<boolean> - .asyncGetSettings() ⇒
Promise.<UserSettings> - .asyncUpdateSettings(settings) ⇒
Promise.<boolean>
userManage.getToken() ⇒ string#
取得登入使用者的token
Kind: static method of userManage
Returns: string - 使用者的token
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="getToken" %}{% endlanying_code_snippet %}userManage.getUid() ⇒ number#
取得登入使用者的uid
Kind: static method of userManage
Returns: number - 使用者ID
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="getUid" %}{% endlanying_code_snippet %}userManage.getAppid() ⇒ string#
取得appid
Kind: static method of userManage
Returns: string - APP ID
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="getAppid" %}{% endlanying_code_snippet %}userManage.getConversationList() ⇒ Array.<ConversationItem>#
取得最近會話列表
Kind: static method of userManage
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="getConversationList" %}{% endlanying_code_snippet %}userManage.getDeviceSN() ⇒ number#
取得設備序號
Kind: static method of userManage
Returns: number - 設備序號
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="getDeviceSN" %}{% endlanying_code_snippet %}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 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="asyncBindDeviceToken" %}{% endlanying_code_snippet %}userManage.asyncUnbindDeviceToken(param) ⇒ Promise.<boolean>#
解綁推播設備
Kind: static method of userManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| param | object | 解綁請求 |
| param.deviceSn | number | 設備序號 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="asyncUnbindDeviceToken" %}{% endlanying_code_snippet %}userManage.asyncRegister(opt) ⇒ Promise.<UserSettings>#
使用者註冊
Kind: static method of userManage
Returns: Promise.<UserSettings> - 使用者設定
| Param | Type | Description |
|---|---|---|
| opt | object | 使用者信息 |
| opt.username | string | 使用者名 |
| opt.password | string | 密碼 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="asyncRegister" %}{% endlanying_code_snippet %}userManage.asyncUpdateAvatar(params) ⇒ Promise.<boolean>#
更新頭像
Kind: static method of userManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| params | object | 參數 |
| params.avatar | string | 頭像 url |
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="asyncUpdateAvatar" %}{% endlanying_code_snippet %}userManage.asyncUpdateNickName(params) ⇒ Promise.<boolean>#
更新暱稱
Kind: static method of userManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| params | object | 參數 |
| params.nick_name | string | 暱稱 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="asyncUpdateNickName" %}{% endlanying_code_snippet %}userManage.asyncUserChangePassword(params) ⇒ Promise.<boolean>#
更新使用者密碼
Kind: static method of userManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| params | object | 參數 |
| params.old_password | string | 舊密碼 |
| params.new_password | string | 新密碼 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="asyncUserChangePassword" %}{% endlanying_code_snippet %}userManage.asyncGetProfile() ⇒ Promise.<UserProfile>#
取得使用者profile
Kind: static method of userManage
Returns: Promise.<UserProfile> - 使用者信息
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="asyncGetProfile" %}{% endlanying_code_snippet %}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 | 公開信息，好友和陌生人可見 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="asyncUpdateProfile" %}{% endlanying_code_snippet %}userManage.asyncGetSettings() ⇒ Promise.<UserSettings>#
取得使用者設定信息
Kind: static method of userManage
Returns: Promise.<UserSettings> - 使用者信息
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="asyncGetSettings" %}{% endlanying_code_snippet %}userManage.asyncUpdateSettings(settings) ⇒ Promise.<boolean>#
修改使用者設定
Kind: static method of userManage
Returns: Promise.<boolean> - 是否成功
| Param | Type | Description |
|---|---|---|
| settings | UserSettings | 更新的設定 |
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="asyncUpdateSettings" %}{% endlanying_code_snippet %}