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#
Get token of logged-in user
Kind: static method of userManage
Returns: string - User's token
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="getToken" %}{% endlanying_code_snippet %}userManage.getUid() ⇒ number#
Get uid of logged-in user
Kind: static method of userManage
Returns: number - User ID
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="getUid" %}{% endlanying_code_snippet %}userManage.getAppid() ⇒ string#
Get 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>#
Get list of recent conversations
Kind: static method of userManage
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="getConversationList" %}{% endlanying_code_snippet %}userManage.getDeviceSN() ⇒ number#
Get device serial number
Kind: static method of userManage
Returns: number - Device serial number
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="getDeviceSN" %}{% endlanying_code_snippet %}userManage.asyncBindDeviceToken(param) ⇒ Promise.<boolean>#
Bind push device
Kind: static method of userManage
Returns: Promise.<boolean> - Success or not
| Param | Type | Description |
|---|---|---|
| param | object | Bind request |
| param.device_sn | number | Device serial number |
| param.notifier_name | string | The certificate name, that is, the name set when uploading the certificate in the LanyingIM Console. |
| param.device_token | string | Push device token |
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="asyncBindDeviceToken" %}{% endlanying_code_snippet %}userManage.asyncUnbindDeviceToken(param) ⇒ Promise.<boolean>#
Unbind push device
Kind: static method of userManage
Returns: Promise.<boolean> - Success or not
| Param | Type | Description |
|---|---|---|
| param | object | Unbind request |
| param.deviceSn | number | Device serial number |
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="asyncUnbindDeviceToken" %}{% endlanying_code_snippet %}userManage.asyncRegister(opt) ⇒ Promise.<UserSettings>#
User registeration
Kind: static method of userManage
Returns: Promise.<UserSettings> - User settings
| Param | Type | Description |
|---|---|---|
| opt | object | User information |
| opt.username | string | Username |
| opt.password | string | Password |
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="asyncRegister" %}{% endlanying_code_snippet %}userManage.asyncUpdateAvatar(params) ⇒ Promise.<boolean>#
Update avatar
Kind: static method of userManage
Returns: Promise.<boolean> - Success or not
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.avatar | string | Avatar url |
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="asyncUpdateAvatar" %}{% endlanying_code_snippet %}userManage.asyncUpdateNickName(params) ⇒ Promise.<boolean>#
Update nickname
Kind: static method of userManage
Returns: Promise.<boolean> - Success or not
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.nick_name | string | Nickname |
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="asyncUpdateNickName" %}{% endlanying_code_snippet %}userManage.asyncUserChangePassword(params) ⇒ Promise.<boolean>#
Update the user password
Kind: static method of userManage
Returns: Promise.<boolean> - Success or not
| Param | Type | Description |
|---|---|---|
| params | object | Parameter |
| params.old_password | string | Old password |
| params.new_password | string | New password |
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="asyncUserChangePassword" %}{% endlanying_code_snippet %}userManage.asyncGetProfile() ⇒ Promise.<UserProfile>#
Get user profile
Kind: static method of userManage
Returns: Promise.<UserProfile> - User information
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="asyncGetProfile" %}{% endlanying_code_snippet %}userManage.asyncUpdateProfile(params) ⇒ Promise.<boolean>#
Update user profile
Kind: static method of userManage
Returns: Promise.<boolean> - Success or not
| Param | Type | Description |
|---|---|---|
| params | object | |
| params.description | string | Description |
| params.nick_name | string | Nickname |
| params.private_info | string | Private information, visible only to yourself |
| params.public_info | string | Public information, visible to both friends and strangers |
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="asyncUpdateProfile" %}{% endlanying_code_snippet %}userManage.asyncGetSettings() ⇒ Promise.<UserSettings>#
Get user settings
Kind: static method of userManage
Returns: Promise.<UserSettings> - User information
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="asyncGetSettings" %}{% endlanying_code_snippet %}userManage.asyncUpdateSettings(settings) ⇒ Promise.<boolean>#
Modify user settings
Kind: static method of userManage
Returns: Promise.<boolean> - Success or not
| Param | Type | Description |
|---|---|---|
| settings | UserSettings | Updated settings |
Example
{% lanying_code_snippet repo="lanying-im-web",class="userManage",function="asyncUpdateSettings" %}{% endlanying_code_snippet %}