• UIKit
  • SDK
  • サーバー API
Chat/
SDK/
Web/
セッション/
SDK
  • Chat SDK のインストール
  • Chat SDK の初期化
  • ログインとログアウト
  • 顧客インターフェース
  • Changelog
  • メッセージ
    • Overview
    • メッセージ送信
    • メッセージの受信
    • 過去のメッセージ
    • メッセージ転送
    • メッセージの変更
    • メッセージ削除
    • 過去のメッセージをクリアします
    • メッセージの取り消し
    • オンラインメッセージの送信
    • メッセージの既読レシート
    • クエリーメッセージ
    • ターゲットグループメッセージ
    • 通知しません
    • Key-Value の拡張
    • 翻訳
  • セッション
    • Overview
    • セッションリスト
    • セッションの取得
    • 未読数
    • セッションの先頭固定表示
    • セッションの削除
    • マーク
    • セッショングループ
  • グループ
    • Overview
    • グループ管理
    • グループプロファイル
    • グループメンバーの管理
    • グループメンバープロファイル
    • グループプロパティのカスタマイズ
    • グループカウンター
  • コミュニティトピック
    • コミュニティ管理
  • ユーザープロファイルとリレーションシップチェーン
    • ユーザープロファイル
    • ユーザー状態
    • 友達管理
    • 友達リスト
    • ブラックリスト
  • Guideline for Beginners
  • コンソールガイド
    • アプリケーションの作成とアップグレード
    • 基本設定
    • 機能設定
    • アカウント管理
    • グループ管理
    • コールバック設定
  • 製品紹介
    • メッセージ管理
      • シングルチャットメッセージ
      • メッセージの保存
      • オフラインプッシュ
      • グループメッセージ
      • メッセージフォーマット
    • アカウントシステム
      • ログイン認証
      • オンライン状態管理
    • グループ関連
      • グループシステム
      • グループ管理
    • ユーザープロファイルとリレーションシップチェーン
      • 資料管理
      • リレーションシップチェーン管理
  • 購入ガイド
    • 課金の概要
    • 価格
  • エラーコード
このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。

マーク

Feature Description

In some cases, you may need to mark a conversation, for example, as "favorite", "collapsed", "hidden", or "unread", which can be implemented through the following API.
Note:
To use this feature, you need to purchase the Premium edition.

Display Effect



Conversation Mark

Marking a conversation

Note:
1. When a user marks a conversation, the SDK simply records the mark value and does not change the underlying logic of the conversation. For example, marking a conversation as CONV_MARK_TYPE_UNREAD does not alter the unread count at the underlying layer.
2. The SDK provides four default marks ("favorite", "collapsed", "hidden", and "unread"). If they cannot meet your requirements, you can customize extended marks, which must meet the following conditions:
The value of an extended mark cannot be the same as that of an existing one.
Custom mark values must be Math.power(2, n) (32 <= n < 64, meaning n must be greater than or equal to 32 and less than 64), for instance, a custom Math.power(2, 32) mark value represents "iPhone Online".
APIAPI
chat.markConversation(options);
Parameters
The options parameter is of the Object type. It contains the following attribute values:
Name
Type
Description
conversationIDList
String
List of conversation IDs
markType
Number
Conversation mark type. The SDK provides four default marks ("favorite", "collapsed", "hidden", and "unread"). If they cannot meet your requirements, you can customize extended marks, which must meet the following conditions: The value of an extended mark cannot be the same as that of an existing one. The value of an extended mark must be Math.power(2, n) (32 ≤ n < 64, indicating that n must be equal to or greater than 32 and less than 64). For example, Math.power(2, 32) indicates "Online on an iPhone".
enableMark
Boolean
true: Mark. false: Unmark
Response
Promise
Sample
// Mark a conversation as "favorite"
let promise = chat.markConversation({
conversationIDList: ['GROUPtest', 'C2Cexample'],
markType: TencentCloudChat.TYPES.CONV_MARK_TYPE_STAR,
enableMark: true
});
promise.then(function(imResponse) {
// Marked the conversation as "favorite" successfully
const { successConversationIDList, failureConversationIDList } = imResponse.data;
// successConversationIDList - List of conversations that were marked successfully
// Get the conversation list
const conversationList = chat.getConversationList(successConversationIDList);

// failureConversationIDList - List of conversations that failed to be marked as "favorite"
failureConversationIDList.forEach((item) => {
const { conversationID, code, message } = item;
});
}).catch(function(imError){
console.warn('markConversation error:', imError);
});

Listening for the notification of a conversation mark change

After a conversation is marked or unmarked, the markList field in Conversation will change. You can listen for such a change notification through the TencentCloudChat.EVENT.CONVERSATION_LIST_UPDATED event.
Sample
let onConversationListUpdated = function(event) {
console.log(event.data); // Array that stores Conversation instances
};
chat.on(TencentCloudChat.EVENT.CONVERSATION_LIST_UPDATED, onConversationListUpdated);

Pulling a specified marked conversation

Call the getConversationList API to pull a specified marked conversation.
Sample
// Obtain all conversations that are marked as "favorite"
let promise = chat.getConversationList({ markType: TencentCloudChat.TYPES.CONV_MARK_TYPE_STAR });
promise.then(function(imResponse) {
const conversationList = imResponse.data.conversationList; // Conversation list
});
// Obtain all one-to-one conversations that are marked as "collapsed"
let promise = chat.getConversationList({
markType: TencentCloudChat.TYPES.CONV_MARK_TYPE_FOLD,
type: TencentCloudChat.TYPES.CONV_C2C
});
promise.then(function(imResponse) {
const conversationList = imResponse.data.conversationList; // Conversation list
});