Methods
switchUserStatus(options) → {void}
用户状态切换开关
Examples
// 开启用户在线状态显示
TUIUserService.switchUserStatus({ displayOnlineStatus: true });// 关闭用户在线状态显示
TUIUserService.switchUserStatus({ displayOnlineStatus: false });Parameters:
| Name | Type | Description |
|---|---|---|
options |
SwitchUserStatusParams |
用户状态控制参数 |
Returns:
- Type
- void
switchMessageReadStatus(displayMessageReadReceipt) → {void}
消息阅读状态切换开关
Examples
// 开启用户消息阅读状态
TUIUserService.switchMessageReadStatus(true);// 关闭用户消息阅读状态
TUIUserService.switchMessageReadStatus(false);Parameters:
| Name | Type | Description |
|---|---|---|
displayMessageReadReceipt |
boolean |
消息阅读状态控制参数 |
Returns:
- Type
- void
getUserProfile(options) → {Promise.<any>}
获取用户资料
Examples
// 查询自己的资料
let promise = TUIUserService.getUserProfile();
promise.catch((error) => {
// 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});// 查询其他用户的资料
let promise = TUIUserService.getUserProfile({ userIDList: ['user1', 'user2'] });
promise.catch((error) => {
// 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});Parameters:
| Name | Type | Description |
|---|---|---|
options |
UserIDListParams |
[options = undefined] 用户 ID 列表，不传 options 默认查询自己的资料 |
Returns:
- Type
- Promise.<any>
updateMyProfile(options) → {Promise.<any>}
更新自己的资料信息
Example
// 更新自己的昵称
let promise = TUIUserService.updateMyProfile({
nick: 'newNick'
});
promise.catch((error) => {
// 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});Parameters:
| Name | Type | Description |
|---|---|---|
options |
UpdateMyProfileParams |
参数选项 |
Returns:
- Type
- Promise.<any>
addToBlacklist(options) → {Promise.<any>}
添加用户到黑名单列表。将用户加入黑名单后可以屏蔽来自 TA 的所有消息，因此该接口可以实现“屏蔽该用户消息”的功能。
Example
let promise = TUIUserService.addToBlacklist({ userIDList: ['user1', 'user2'] });
promise.catch((error) => {
// 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});Parameters:
| Name | Type | Description |
|---|---|---|
options |
UserIDListParams |
参数选项 |
Returns:
- Type
- Promise.<any>
removeFromBlacklist(options) → {Promise.<any>}
从黑名单列表中移除
Example
let promise = TUIUserService.removeFromBlacklist({ userIDList: ['user1', 'user2'] });
promise.catch((error) => {
// 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});Parameters:
| Name | Type | Description |
|---|---|---|
options |
UserIDListParams |
参数选项 |
Returns:
- Type
- Promise.<any>