Methods
addFriend(options) → {Promise.<any>}
添加好友
Example
let promise = TUIFriendService.addFriend({
to: 'user1',
source: 'AddSource_Type_Web',
remark: '小橙子',
groupName: '好友',
wording: '我是 user0',
type: TUIChatEngine.TYPES.SNS_ADD_TYPE_BOTH,
});
promise.catch((error) => {
// 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});Parameters:
| Name | Type | Description |
|---|---|---|
options |
AddFriendParams |
参数选项 |
Returns:
- Type
- Promise.<any>
deleteFriend(options) → {Promise.<any>}
删除好友
Example
let promise = TUIFriendService.deleteFriend({
userIDList: ['user1','user2'],
type: TUIChatEngine.TYPES.SNS_DELETE_TYPE_BOTH
});
promise.catch((error) => {
// 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});Parameters:
| Name | Type | Description |
|---|---|---|
options |
DeleteFriendParams |
参数选项 |
Returns:
- Type
- Promise.<any>
checkFriend(options) → {Promise.<any>}
校验好友关系
Example
let promise = TUIFriendService.checkFriend({
userIDList: ['user1','user2'],
type: TUIChatEngine.TYPES.SNS_CHECK_TYPE_BOTH
});
promise.catch((error) => {
// 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});Parameters:
| Name | Type | Description |
|---|---|---|
options |
CheckFriendParams |
参数选项 |
Returns:
- Type
- Promise.<any>
getFriendProfile(options) → {Promise.<any>}
获取指定好友的全量好友数据（包含好友标配字段和好友自定义字段）和全量资料数据（包含资料标配字段和资料自定义字段）。
Example
let promise = TUIFriendService.getFriendProfile({
userIDList: ['user1','user2']
});
promise.catch((error) => {
// 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});Parameters:
| Name | Type | Description |
|---|---|---|
options |
GetFriendProfileParams |
参数选项 |
Returns:
- Type
- Promise.<any>
updateFriend(options) → {Promise.<any>}
更新好友的关系链数据，只支持好友备注、关系链自定义字段的更新操作。
Examples
// 更新好友备注
let promise = TUIFriendService.updateFriend({
userID: 'user1',
remark: 'aallen'
});
promise.catch((error) => {
// 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});// 更新好友自定义字段
let promise = TUIFriendService.updateFriend({
userID: 'user1',
friendCustomField: [
// 好友自定义字段必须以 Tag_SNS_Custom 为前缀
{ key: 'Tag_SNS_Custom_test1', value: 'hello' },
{ key: 'Tag_SNS_Custom_test2', value: 'world' },
]
});
promise.catch((error) => {
// 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});Parameters:
| Name | Type | Description |
|---|---|---|
options |
UpdateFriendParams |
参数选项 |
Returns:
- Type
- Promise.<any>
acceptFriendApplication(options) → {Promise.<any>}
同意好友申请
Example
let promise = TUIFriendService.acceptFriendApplication({
userID: 'user1',
remark: '客服小亮',
type: TUIChatEngine.TYPES.SNS_APPLICATION_AGREE_AND_ADD
});
promise.catch((error) => {
// 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});Parameters:
| Name | Type | Description |
|---|---|---|
options |
AcceptFriendApplicationParams |
参数选项 |
Returns:
- Type
- Promise.<any>
refuseFriendApplication(userID) → {Promise.<any>}
拒绝好友申请
Example
let promise = TUIFriendService.refuseFriendApplication('user1');
promise.catch((error) => {
// 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});Parameters:
| Name | Type | Description |
|---|---|---|
userID |
string |
被拒绝用户的 userID |
Returns:
- Type
- Promise.<any>
deleteFriendApplication(options) → {Promise.<any>}
删除好友申请
Example
let promise = TUIFriendService.deleteFriendApplication({
userID: 'user1',
type: TUIChatEngine.TYPES.SNS_APPLICATION_SENT_TO_ME
});
promise.catch((error) => {
// 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});Parameters:
| Name | Type | Description |
|---|---|---|
options |
DeleteFriendApplicationParams |
参数选项 |
Returns:
- Type
- Promise.<any>
setFriendApplicationRead() → {Promise.<any>}
上报好友申请已读
Returns:
- Type
- Promise.<any>