ITUIConversationService

Methods

switchConversation(conversationID) → {Promise.<any>}

切换会话

Example

// 切换到 public001 群会话
let promise = TUIConversationService.switchConversation('GROUPpublic001');
promise.catch((error) => {
 // 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});

Parameters:

Name	Type	Description
`conversationID`	String	会话 ID，conversationID 生成规则：单聊（`C2C${userID}`），群聊（`GROUP${groupID}`）。

Returns:

Type: Promise.<any>

getConversationProfile(conversationID) → {Promise.<any>}

获取会话资料注意：Service API 主要用于跨组件时调用

Example

// 获取 public001 群会话资料
let promise = TUIConversationService.getConversationProfile('GROUPpublic001');
promise.then((chatResponse) => {
 console.log(chatResponse.data.conversation); // 会话资料
});
promise.catch((error) => {
 // 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});

Parameters:

Name	Type	Description
`conversationID`	String	会话 ID

Returns:

Type: Promise.<any>

clearHistoryMessage(conversationID) → {Promise.<any>}

一键清空历史消息

Example

let promise = TUIConversationService.clearHistoryMessage('GROUPpublic001');
promise.catch((error) => {
 // 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});

Parameters:

Name	Type	Description
`conversationID`	String	会话 ID

Returns:

Type: Promise.<any>

setConversationDraft(options) → {Promise.<any>}

设置会话草稿

Examples

// 设置会话草稿
let promise = TUIConversationService.setConversationDraft({
  conversationID: 'GROUPpublic001',
  darftInfo: {
   html: 'test';
   abstract: 'test';
  }
});
promise.catch((error) => {
 // 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});

// 清空会话草稿
let promise = TUIConversationService.setConversationDraft({
  conversationID: 'GROUPpublic001',
});
promise.catch((error) => {
 // 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});

Parameters:

Name	Type	Description
`options`	SetConversationDraftParams	参数选项

Returns:

Type: Promise.<any>