ITUIChatService

Methods

sendTextMessage(options, sendMessageOptionsopt) → {Promise.<any>}

Examples

// 发送普通文本消息
let promise = TUIChatService.sendTextMessage({
 payload: {
   text: 'Hello world!'
 },
});
promise.catch((error) => {
 // 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});

// 发送普通文本消息并携带消息自定义数据
let promise = TUIChatService.sendTextMessage({
 payload: {
   text: 'Hello world!'
 },
 cloudCustomData: 'your cloud custom data'
});
promise.catch((error) => {
 // 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});

Parameters:

Returns:

Type

Promise.<any>

sendTextAtMessage(options, sendMessageOptionsopt) → {Promise.<any>}

Example

// 发送 @ 消息
let promise = TUIChatService.sendTextAtMessage({
 payload: {
   text: '@denny @lucy @所有人 今晚聚餐，收到的请回复1',
   atUserList: ['denny', 'lucy', TUIChatEngine.TYPES.MSG_AT_ALL] // 'denny' 'lucy' 都是 userID，而非昵称
 },
});
promise.catch((error) => {
 // 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});

Parameters:

Returns:

Type

Promise.<any>

sendImageMessage(options, sendMessageOptionsopt) → {Promise.<any>}

Example

// 发送图片消息
let promise = TUIChatService.sendImageMessage({
 payload: {
   file: file
 },
});
promise.catch((error) => {
 // 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});

Parameters:

Returns:

Type

Promise.<any>

sendAudioMessage(options, sendMessageOptionsopt) → {Promise.<any>}

Example

// 发送音频消息
let promise = TUIChatService.sendAudioMessage({
 payload: {
   file: file
 },
});
promise.catch((error) => {
 // 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});

Parameters:

Returns:

Type

Promise.<any>

sendVideoMessage(options, sendMessageOptionsopt) → {Promise.<any>}

Example

// 发送视频消息
let promise = TUIChatService.sendVideoMessage({
 payload: {
   file: file
 },
});
promise.catch((error) => {
 // 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});

Parameters:

Returns:

Type

Promise.<any>

sendFileMessage(options, sendMessageOptionsopt) → {Promise.<any>}

Example

// 发送文件消息
let promise = TUIChatService.sendFileMessage({
 payload: {
   file: file
 },
});
promise.catch((error) => {
 // 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});

Parameters:

Returns:

Type

Promise.<any>

sendCustomMessage(options, sendMessageOptionsopt) → {Promise.<any>}

Example

// 发送自定义消息
let promise = TUIChatService.sendCustomMessage({
 payload: {
  data: 'dice', // 用于标识该消息是骰子类型消息
  description: String(random(1,6)), // 获取骰子点数
  extension: ''
 },
});
promise.catch((error) => {
 // 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});

Parameters:

Returns:

Type

Promise.<any>

sendFaceMessage(options, sendMessageOptionsopt) → {Promise.<any>}

Example

// 发送自定义消息
let promise = TUIChatService.sendFaceMessage({
 payload: {
   index: 1, // Number 表情索引，用户自定义
   data: 'tt00' // String 额外数据
 },
});
promise.catch((error) => {
 // 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});

Parameters:

Returns:

Type

Promise.<any>

sendLocationMessage(options, sendMessageOptionsopt) → {Promise.<any>}

Example

// 发送地理位置消息
let promise = TUIChatService.sendLocationMessage({
 payload: {
  description: '深圳市深南大道10000号腾讯大厦',
  longitude: 113.941079, // 经度
  latitude: 22.546103 // 纬度
 },
});
promise.catch((error) => {
 // 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});

Parameters:

Returns:

Type

Promise.<any>

sendForwardMessage(conversationList, messageList, sendForwardMessageOptionsopt) → {Promise.<any>}

Examples

// 逐条转发，把当前会话的 message1，message2 逐条转发给会话 conversation1, conversation2
let promise = TUIChatService.sendForwardMessage([conversation1, conversation2], [message1, message2]);
promise.catch((error) => {
 // 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});

// 合并转发，把当前会话的 message1，message2 合并转发给会话conversation1, conversation2
let promise = TUIChatService.sendForwardMessage([conversation1, conversation2], [message1, message2], { needMerge: true });
promise.catch((error) => {
 // 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});

// 合并转发，把当前会话的 message1，message2 合并转发给会话 conversation1, conversation2, 自定义合并后的消息 title
const sendForwardMessageOptions = {
   needMerge: true,
   // 合并转发配置项，needMerge = true 时生效。
`  mergeInfo: {
     title: '自定义合并后的消息 title'
   }
}
let promise = TUIChatService.sendForwardMessage([conversation1, conversation2], [message1, message2], sendForwardMessageOptions);
promise.catch((error) => {
 // 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});

Parameters:

Returns:

Type

Promise.<any>

enterTypingState() → {void}

Example

TUIChatService.enterTypingState();

Returns:

Type

void

leaveTypingState() → {void}

Example

TUIChatService.leaveTypingState();

Returns:

Type

void

sendMessageReadReceipt(messageList) → {Promise.<any>}

Example

let promise = TUIChatService.sendMessageReadReceipt([messageModel1, messageModel2, messageModel3]);
promise.catch((error) => {
 // 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});

Parameters:

Returns:

Type

Promise.<any>

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

Examples

// 获取已读群成员列表
let promise = TUIChatService.getGroupMessageReadMemberList({
 message,
 filter: 0,
 cursor: '', // 第一次拉取传''
 count: 30,
});
promise.then(function(response) {
 const { isCompleted, cursor, messageID, readUserInfoList } = response;
  // isCompleted - true，拉取完成；false 未完成
  // cursor - 当 isCompleted 为 false 的时候用于续拉
  // messageID - 群消息的 ID
  // readUserInfoList - 已读的群成员用户信息列表
});
promise.catch((error) => {
 // 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});

// 获取未读群成员列表
let promise = TUIChatService.getGroupMessageReadMemberList({
 message,
 filter: 1,
 cursor: '', // 第一次拉取传''
 count: 30,
});
promise.then(function(response) {
 const { isCompleted, cursor, messageID, unreadUserInfoList } = response;
  // isCompleted - true，拉取完成；false 未完成
  // cursor - 当 isCompleted 为 false 的时候用于续拉
  // messageID - 群消息的 ID
  // unreadUserInfoList - 未读的群成员用户信息列表
});
promise.catch((error) => {
 // 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});

Parameters:

Returns:

Type

Promise.<any>

getMessageList(optionsopt) → {Promise.<any>}

Example

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

Parameters:

Returns:

Type

Promise.<any>

downloadMergedMessages(message) → {Promise.<any>}

Example

if (message.type === TUIChatEngine.TYPES.MSG_MERGER && message.payload.downloadKey !== '') {
 // 下载成功后，SDK会更新 message.payload.messageList 等信息
 let promise = TUIChatService.downloadMergedMessages(message);
 promise.catch((error) => {
   // 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
 });
}

Parameters:

Returns:

Type

Promise.<any>

setTranslationLanguage(language) → {void}

Example

TUIChatService.setTranslationLanguage('en');

Parameters:

Returns:

Type

void

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

Example

let promise = TUIChatService.translateText({
 sourceTextList: ['مرحبًا'],
 sourceLanguage: 'auto',
});
promise.then((chatResponse) => {
 // 翻译成功 translatedTextList 和 sourceTextList 的元素一一对应
 const { translatedTextList } = chatResponse.data;
});

Parameters:

Returns:

Type

Promise.<any>

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

Examples

// 全量搜索，指定关键字
// - 搜索消息里出现 ‘你好’ 或 ‘在哪里’
let promise = TUIChatService.searchCloudMessages({
   keywordList: ['你好', '在哪里'],
});

// 全量搜索，指定关键字和匹配类型搜索
// - 搜索消息里出现了 ‘你好’ 与 ‘在哪里’ 的消息
let promise = TUIChatService.searchCloudMessages({
   keywordList: ['你好', '在哪里'],
   keywordListMatchType: 'and',
});

// 全量搜索，指定关键字列表和消息发送者搜索
// - 搜索消息发送者为 ‘user1’ 或 ‘user2’，且消息里出现了 ‘你好’ 或 ‘在哪里’ 的消息
let promise = TUIChatService.searchCloudMessages({
   keywordList: ['你好', '在哪里'],
   senderUserIDList: ['user1', 'user2'],
});

// 全量搜索，指定关键字和消息类型搜索
// - 搜索消息类型为 ‘文本消息’ 或 ‘自定义消息’，且消息里出现了 ‘你好’ 或 ‘在哪里’ 的消息
let promise = TUIChatService.searchCloudMessages({
   keywordList: ['你好', '在哪里'],
   messageTypeList: [TUIChatEngine.TYPES.MSG_TEXT, TUIChatEngine.TYPES.MSG_CUSTOM],
});

// 全量搜索，搜索所有图片消息（当指定发送者或消息类型时，关键字列表可以为空）
let promise = TUIChatService.searchCloudMessages({
   messageTypeList: [TUIChatEngine.TYPES.MSG_IMAGE],
});

// 全量搜索，只指定消息发送者和消息类型搜索（当指定发送者或消息类型时，关键字列表可以为空）
// - 搜索消息发送者为 ‘user1’ 或 ‘user2’，且消息类型为 ‘文本消息’ 或 ‘自定义消息’ 的消息
let promise = TUIChatService.searchCloudMessages({
   senderUserIDList: ['user1', 'user2'],
   messageTypeList: [TUIChatEngine.TYPES.MSG_TEXT, TUIChatEngine.TYPES.MSG_CUSTOM],
});

// 全量搜索，指定关键字和时间（过去一天）搜索
// - 搜索过去一天，消息里出现了 ‘你好’ 或 ‘在哪里’的消息
let promise = TUIChatService.searchCloudMessages({
   keywordList: ['你好', '在哪里'],
   timePosition: Number((new Date().getTime()/1000).toFixed(0)),
   timePeriod: 24 * 60 * 60,
});
promise.then(function(imResponse) {
 // 搜索消息成功
   const { totalCount, cursor，searchResultList } = imResponse.data;
   console.log(totalCount); // 满足搜索条件的消息所在的所有会话总数量
   console.log(cursor); // 下一次云端搜索的起始位置, 如果没有表示搜索结果拉取完成
   console.log(searchResultList); // 满足搜索条件的消息根据会话 ID 分组，分页返回分组结果
   for (let i = 0; i < searchResultList.length; i++) {
      const searchResultItem = searchResultList[i];
      const { conversationID, messageCount, messageList } = searchResultItem;
      console.log(conversationID); // 会话 ID
      console.log(messageCount); // 当前会话一共搜索到了多少条符合要求的消息
      // 本次搜索【全部会话】，那么 messageList 中装载的消息条数会有如下两种可能：
      // - 如果某个会话中匹配到的消息条数 > 1，则 messageList 为空，您可以在 UI 上显示“ messageCount 条相关记录”。
      // - 如果某个会话中匹配到的消息条数 = 1，则 messageList 为匹配到的那条消息，您可以在 UI 上显示之，并高亮匹配关键词。
      console.log(messageList);
    }
}).catch(function(imError) {
   console.error(imError); // 搜索消息失败
});

// 指定会话，指定关键字搜索
// - 搜索在 'GROUPPublic001' 会话中，消息里出现 ‘你好’ 或 ‘在哪里’ 的消息。
let promise = TUIChatService.searchCloudMessages({
   keywordList: ['你好', '在哪里'],
   conversationID: 'GROUPPublic001'
});

// 指定会话，指定消息类型搜索（当指定发送者或消息类型时，关键字列表可以为空）
// - 在 'GROUPPublic001' 会话中，搜索图片消息。
let promise = TUIChatService.searchCloudMessages({
   conversationID: 'GROUPPublic001',
   messageTypeList: [TUIChatEngine.TYPES.MSG_IMAGE],
});

// 指定会话，指定关键字和消息类型搜索
// - 搜索在 'GROUPPublic001' 会话中，消息里出现 ‘你好’ 或 ‘在哪里’，且消息类型为 ‘文本消息’ 或 ’自定义消息’ 的消息。
let promise = TUIChatService.searchCloudMessages({
   keywordList: ['你好', '在哪里'],
   conversationID: 'GROUPPublic001'
   messageTypeList: [TUIChatEngine.TYPES.MSG_TEXT, TUIChatEngine.TYPES.MSG_CUSTOM],
});

// 指定会话，指定关键字和时间（过去一天）搜索
// - 搜索过去一天，在 'GROUPPublic001' 会话中，消息里出现 ‘你好’ 或 ‘在哪里’ 的消息。
let promise = TUIChatService.searchCloudMessages({
   keywordList: ['你好', '在哪里'],
   conversationID: 'GROUPPublic001'
   timePosition: Number((new Date().getTime()/1000).toFixed(0)),
   timePeriod: 24 * 60 * 60,
});
promise.then(function(imResponse) {
   // 搜索消息成功
   const { totalCount, cursor, searchResultList } = imResponse.data;
   console.log(totalCount); // 满足搜索条件的消息总数量
   console.log(cursor); // 下一次云端搜索的起始位置, 如果没有表示搜索结果拉取完成
   console.log(searchResultList); // 当前会话搜索的消息结果
   const { conversationID, messageCount, messageList } = searchResultList[0];
   console.log(conversationID); // 会话ID
   console.log(messageCount); // 当前会话一共搜索到了多少条符合要求的消息
   console.log(messageList); // 本会话中所有满足搜索条件的消息列表
}).catch(function(imError); {
   console.error(imError); // 搜索消息失败
});

Parameters:

Returns:

Type

Promise.<any>

addMessageReaction(message, reactionID) → {Promise.<any>}

Example

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

Parameters:

Returns:

Type

Promise.<any>

removeMessageReaction(message, reactionID) → {Promise.<any>}

Example

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

Parameters:

Returns:

Type

Promise.<any>

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

Example

let promise = TUIChatService.getAllUserListOfMessageReaction({
  message: message,
  reactionID: 'smile',
  nextSeq: 0,
  count: 100,
});
promise.then(function(response) {
  // 获取成功
  const { userList, nextSeq, isCompleted } = response.data;
  // userList - 用户信息列表，包含用户的 userID、nick、avatar 信息
  // nextSeq - 用于续拉，分页续拉时需传入该字段
  // isCompleted - 表示是否已经拉完所有的用户信息。isCompleted 为 true 时，nextSeq 为 0
}).catch(function(error) {
  // 调用异常时业务侧可以通过 promise.catch 捕获异常进行错误处理
});

Parameters:

Returns:

Type

Promise.<any>

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

Examples

// 将语音转为中文
let promise = TUIChatService.convertVoiceToText({
 message: audioMessageModel,
});
promise.then((chatResponse) => {
 const { result } = chatResponse.data;
});

// 将语音转为日文
let promise = TUIChatService.convertVoiceToText({
 message: audioMessageModel,
 language: 'ja-JP',
});
promise.then((chatResponse) => {
 const { result } = chatResponse.data;
});

Parameters:

Returns:

Type

Promise.<any>

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

Example

// 清空群聊 groupID 为 test 的历史消息
let promise = TUIChatService.clearHistoryMessage('GROUPtest');
promise.then((chatResponse) => {
 const { result } = chatResponse.data;
});

Parameters:

Returns:

Type

Promise.<any>