tencent cloud

PrevNext

フィードバック

キーワードで検索してください

Recent Pages

ドキュメント
Chat
    ドキュメント
    Download PDF

    SDK API（Web）

    最終更新日:2023-02-06 14:54:21
    PDFファイルをダウンロード

      TIM

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

      初期化

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

      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 説明
      destroy SDKインスタンスを廃棄します。

      ログイン関連

      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 グループメッセージの既読（または未読）メンバーリストを取得します。
      findMessage messageIDに基づいてセッションのローカルメッセージをクエリーします。
      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 説明
      getFriendList SDKによってキャッシュされた友達リストを取得します。
      addFriend 友達を追加します。
      deleteFriend 友達を削除します。
      checkFriend 友好度を確認します。
      getFriendProfile 指定した友達のフレンドデータとプロフィールデータを取得します。
      updateFriend 友達のリレーショナルチェーンデータを更新します。
      getFriendApplicationList SDKによってキャッシュされた友達申請リストを取得します。
      acceptFriendApplication 友達申請に同意します。
      refuseFriendApplication 友達申請を拒否します。
      deleteFriendApplication 友達申請を削除します。
      setFriendApplicationRead 友達申請を既読として報告します。
      getFriendGroupList SDKによってキャッシュされた友達のサブグループリストを取得します。
      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 トピックリストを取得します。
      お問い合わせ

      カスタマーサービスをご提供できるため、ぜひお気軽にお問い合わせくださいませ。

      お問い合わせ
      テクニカルサポート

      さらにサポートが必要な場合は、サポートチケットを送信して弊社サポートチームにお問い合わせください。24時間365日のサポートをご提供します。

      チケットを送信
      電話サポート（24 時間365日対応）
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      個人情報保護方針利用規約クッキーポリシー