• UIKit
  • SDK
  • サーバー API
Chat/
SDK/
Web/
SDK
  • Chat SDK のインストール
  • Chat SDK の初期化
  • ログインとログアウト
  • 顧客インターフェース
  • Changelog
  • メッセージ
    • Overview
    • メッセージ送信
    • メッセージの受信
    • 過去のメッセージ
    • メッセージ転送
    • メッセージの変更
    • メッセージ削除
    • 過去のメッセージをクリアします
    • メッセージの取り消し
    • オンラインメッセージの送信
    • メッセージの既読レシート
    • クエリーメッセージ
    • ターゲットグループメッセージ
    • 通知しません
    • Key-Value の拡張
    • 翻訳
  • セッション
    • Overview
    • セッションリスト
    • セッションの取得
    • 未読数
    • セッションの先頭固定表示
    • セッションの削除
    • マーク
    • セッショングループ
  • グループ
    • Overview
    • グループ管理
    • グループプロファイル
    • グループメンバーの管理
    • グループメンバープロファイル
    • グループプロパティのカスタマイズ
    • グループカウンター
  • コミュニティトピック
    • コミュニティ管理
  • ユーザープロファイルとリレーションシップチェーン
    • ユーザープロファイル
    • ユーザー状態
    • 友達管理
    • 友達リスト
    • ブラックリスト
  • Guideline for Beginners
  • コンソールガイド
    • アプリケーションの作成とアップグレード
    • 基本設定
    • 機能設定
    • アカウント管理
    • グループ管理
    • コールバック設定
  • 製品紹介
    • メッセージ管理
      • シングルチャットメッセージ
      • メッセージの保存
      • オフラインプッシュ
      • グループメッセージ
      • メッセージフォーマット
    • アカウントシステム
      • ログイン認証
      • オンライン状態管理
    • グループ関連
      • グループシステム
      • グループ管理
    • ユーザープロファイルとリレーションシップチェーン
      • 資料管理
      • リレーションシップチェーン管理
  • 購入ガイド
    • 課金の概要
    • 価格
  • エラーコード

顧客インターフェース

TIM

TIMは、IM Web SDKのネームスペースです。SDKインスタンスの静的メソッドcreate()、イベント常数EVENT、およびタイプ常数TYPESを提供します。

初期化

API説明
createSDKインスタンスを作成します。

SDKインスタンス

基本概念説明
Message(メッセージ)IM SDKのMessageは相手に送信する内容を表します。メッセージには、送信者かどうか、送信者のアカウント番号、メッセージの生成時刻など、いくつかの属性が含まれています。
Conversation(セッション)IM SDKのConversationは2種類に分けられます
  • C2C(Client to Client)セッションは、シングルチャットの場合、自分と相手の間で確立されたセッションを意味します。
  • GROUP(グループ)セッションは、グループチャットの場合、グループメンバーが形成するセッションを意味します。
  • Profile(プロファイル)IM SDKのProfileは、ニックネーム、性別、個人署名、およびプロファイルフォトアドレスなど、よく使用する個人の基本情報を記述します。
    Friend(友達)IM SDKのFriendは、メモやグループなど、よく使用する友達の基本情報を記述します。
    FriendApplication(友達申請)IM SDKのFriendApplicationは、友達追加のソースやメモなど、友達の申請でよく使用する基本情報を記述します。
    FriendGroup(友達グループ)IM SDKのFriendGroupは、グループ名やグループメンバーなど、友達グループによく使用する基本情報を記述します。
    Group(グループ)IMのGroupは、複数人でのチャットをサポートする通信システムです。友人のワークグループ、知らない人とのソーシャルグループ、臨時ミーティンググループ、ライブブロードキャストグループをサポートします。
    GroupMember(グループメンバー)IM SDKのGroupMemberは、ID、ニックネーム、グループ内でのアイデンティティ、およびグループへの加入時間など、よく使用するグループメンバーの基本情報を記述します。
    グループプロンプトメッセージユーザーがグループに招待されたり、グループから削除されたりするなどのイベントが発生するとき、グループ内でプロンプトメッセージが生成され、アクセス側は実際のニーズに応じてグループユーザーに表示したり無視したりできます。
    グループプロンプトメッセージにはさまざまなタイプがあります。詳細の説明については、Message.GroupTipPayloadをご参照ください。
    グループシステム通知メッセージユーザーがグループへの参加を申請するなどのイベントが発生するとき、管理者はグループへの参加申請などのシステムメッセージを受け取ります。管理者がグループへの参加申請に同意または拒否した場合、IM SDKはグループへの参加申請などの対応するメッセージをグループシステム通知メッセージを通じてアクセス側に送信し、アクセス側はそれをユーザーに表示します。
    グループシステム通知メッセージにはさまざまなタイプがあります。詳細の説明については、Message.GroupSystemNoticePayloadをご参照ください。
    メッセージの画面表示ユーザーが送信をクリックすると、事前に入力されたテキストや選択された画像などの情報が、ユーザーのコンピューターまたは携帯電話の画面に表示される過程です。

    イベント関連

    API説明
    onイベントをリッスンします。
    offイベントのリッスンをキャンセルします。

    プラグインの登録

    API説明
    registerPluginプラグインを登録します。

    ログレベルの設定

    API説明
    setLogLevelログレベルを設定します。

    SDKインスタンスの廃棄

    API説明
    destroySDKインスタンスを廃棄します。

    ログイン関連

    API説明
    loginログインします。
    logoutログアウトします。

    メッセージ

    API説明
    createTextMessageテキストメッセージを作成します。
    createTextAtMessage@リマインダ通知機能があるテキストメッセージを作成します。
    createImageMessage画像メッセージを作成します。
    createAudioMessageオーディオメッセージを作成します。
    createVideoMessageビデオメッセージを作成します。
    createCustomMessageカスタムメッセージを作成します。
    createFaceMessage絵文字メッセージを作成します。
    createFileMessageファイルメッセージを作成します。
    createLocationMessage地理位置メッセージを作成します。
    createMergerMessageマージメッセージを作成します。
    downloadMergerMessageマージメッセージをダウンロードします。
    createForwardMessage転送メッセージを作成します。
    sendMessageメッセージを送信します。
    revokeMessageメッセージを撤回します。
    resendMessageメッセージを再送します。
    deleteMessageメッセージを削除します。
    setMessageExtensionsメッセージ拡張子を設定します。
    getMessageExtensionsメッセージ拡張子を取得します。
    deleteMessageExtensionsメッセージ拡張子を削除します。

    セッション

    API説明
    modifyMessageメッセージを変更します。
    getMessageListメッセージリストを取得します。
    getMessageListHopping指定されたメッセージsequenceまたはメッセージ時間によってセッションのメッセージリストを取得します。
    sendMessageReadReceiptメッセージの開封確認を送信します。
    getMessageReadReceiptList開封確認リストを取得します。
    getGroupMessageReadMemberListグループメッセージの既読(または未読)メンバーリストを取得します。
    findMessagemessageIDに基づいてセッションのローカルメッセージをクエリーします。
    setMessageReadメッセージの開封確認を設定します。
    getConversationListセッションリストを取得します。
    getConversationProfileセッションのプロファイルを取得します。
    deleteConversationセッションを削除します。
    clearHistoryMessageシングルチャットまたはグループチャットのローカルメッセージとクラウドメッセージをクリアします(セッションを削除しません)。
    pinConversationセッションをトップにしたりトップにすることをキャンセルしたりします。
    setAllMessageReadすべてのセッションの未読メッセージを既読に設定します。
    setMessageRemindTypeセッションメッセージのリマインダ通知タイプを設定します。このインターフェースを使用して、「メッセージ通知オフ」および「メッセージの拒否」機能を実現できます。
    getTotalUnreadMessageCountセッション未読総数を取得します。

    セッションのサブグループ

    API説明
    setConversationCustomDataセッションのカスタムデータを設定します。
    markConversationセッションをタグつけます。
    getConversationGroupListセッションのサブグループリストを取得します。
    createConversationGroupセッションのサブグループを作成します。
    deleteConversationGroupセッションのサブグループを削除します。
    renameConversationGroupセッションのサブグループをリネームします。
    addConversationsToGroupセッションをセッションのサブグループに追加します。
    deleteConversationsFromGroupセッションのサブグループからセッションを削除します。

    プロファイル

    API説明
    getMyProfile個人情報を取得します。
    getUserProfileその他のユーザー個人情報を取得します。
    updateMyProfile個人情報を更新します。
    getBlacklist自分のブラックリストを取得します。
    addToBlacklistユーザーをブラックリストに追加します。
    removeFromBlacklistブラックリストからユーザーを削除します。

    ユーザー状態

    API説明
    setSelfStatus自分のカスタム状態を設定します。
    getUserStatusユーザー状態をクエリーします。
    subscribeUserStatusユーザー状態をサブスクリプションします。
    subscribeUserStatusユーザー状態のサブスクリプションをキャンセルします。

    リレーショナルチェーン

    API説明
    getFriendListSDKによってキャッシュされた友達リストを取得します。
    addFriend友達を追加します。
    deleteFriend友達を削除します。
    checkFriend友好度を確認します。
    getFriendProfile指定した友達のフレンドデータとプロフィールデータを取得します。
    updateFriend友達のリレーショナルチェーンデータを更新します。
    getFriendApplicationListSDKによってキャッシュされた友達申請リストを取得します。
    acceptFriendApplication友達申請に同意します。
    refuseFriendApplication友達申請を拒否します。
    deleteFriendApplication友達申請を削除します。
    setFriendApplicationRead友達申請を既読として報告します。
    getFriendGroupListSDKによってキャッシュされた友達のサブグループリストを取得します。
    createFriendGroup友達のサブグループを作成します。
    deleteFriendGroup友達のサブグループを削除します。
    addToFriendGroup友達のサブグループリストに追加します。
    removeFromFriendGroup友達のサブグループから友達を削除します。
    renameFriendGroup友達のサブグループをリネームします。

    グループ

    API説明
    getGroupListグループリストを取得します。
    getGroupProfileグループの詳細データを取得します。
    createGroupグループを作成します。
    dismissGroupグループを解散します。
    updateGroupProfileグループデータを変更します。
    joinGroupグループへの参加を申請します。
    quitGroupグループから退出します。
    searchGroupByIDグループを検索します。
    getGroupOnlineMemberCountライブブロードキャストグループのオンライン人数を取得します。
    changeGroupOwnerグループを転送します。
    getGroupApplicationListグループへの参加リストを取得します。
    handleGroupApplicationグループへの参加を処理します。
    initGroupAttributesグループ属性を初期化します。
    setGroupAttributesグループ属性を設定します。
    deleteGroupAttributesグループ属性を削除します。
    getGroupAttributesグループ属性を取得します。

    グループメンバー

    API説明
    getGroupMemberListグループメンバーリストを取得します。
    getGroupMemberProfileグループメンバーの個人情報を取得します。
    addGroupMemberグループメンバーを追加します。
    deleteGroupMemberグループメンバーを削除します。
    setGroupMemberMuteTimeグループメンバーの発言禁止時間を設定します。
    setGroupMemberRoleグループメンバーのロールを変更します。
    setGroupMemberNameCardグループメンバーのプロファイルを設定します。
    setGroupMemberCustomFieldグループメンバーのカスタムフィールドを設定します。
    markGroupMemberListグループメンバをタグつけます。

    トピック

    API説明
    getJoinedCommunityList現在のユーザーが参加しているトピックをサポートするコミュニティリストを取得します。
    createTopicInCommunityトピックを作成します。
    deleteTopicFromCommunityトピックを削除します。
    updateTopicProfileトピックデータを更新します。
    getTopicListトピックリストを取得します。