DirectMessagesClient

​

サブモジュール

• xdk.direct_messages.client モジュール
  • DirectMessagesClient
    • DirectMessagesClient.__init__()
    • DirectMessagesClient.create_by_conversation_id()
    • DirectMessagesClient.create_by_participant_id()
    • DirectMessagesClient.create_conversation()
    • DirectMessagesClient.delete_events()
    • DirectMessagesClient.get_events()
    • DirectMessagesClient.get_events_by_conversation_id()
    • DirectMessagesClient.get_events_by_id()
    • DirectMessagesClient.get_events_by_participant_id()
• xdk.direct_messages.models モジュール
  • CreateByConversationIdRequest
    • CreateByConversationIdRequest.model_config
  • CreateByConversationIdResponse
    • CreateByConversationIdResponse.model_config
  • CreateByParticipantIdRequest
    • CreateByParticipantIdRequest.model_config
  • CreateByParticipantIdResponse
    • CreateByParticipantIdResponse.model_config
  • CreateConversationRequest
    • CreateConversationRequest.model_config
  • CreateConversationResponse
    • CreateConversationResponse.model_config
  • DeleteEventsResponse
    • DeleteEventsResponse.model_config
  • GetEventsByConversationIdResponse
    • GetEventsByConversationIdResponse.model_config
  • GetEventsByIdResponse
    • GetEventsByIdResponse.model_config
  • GetEventsByParticipantIdResponse
    • GetEventsByParticipantIdResponse.model_config
  • GetEventsResponse
    • GetEventsResponse.model_config

​

モジュールの内容

このモジュールは、X API のダイレクトメッセージ用エンドポイントへのアクセスを提供し、 ダイレクトメッセージ関連のすべての機能への主なエントリポイントとして機能します。

​

class xdk.direct_messages.DirectMessagesClient

ダイレクトメッセージ関連の操作を行う Client

​

パラメータ

path.client · Client

​

__init__

​

パラメータ

path.client · Client

​

create_by_conversation_id

会話IDを指定してDMメッセージを作成する 指定した会話IDに新しいダイレクトメッセージを送信します。

​

パラメーター

path.dm_conversation_id · str

DM 会話の ID。

body.body · CreateByConversationIdRequest

リクエストボディ

​

create_by_participant_id

参加者のidを指定してDMメッセージを作成

特定の参加者のidを指定して、新しいダイレクトメッセージを送信します。

​

Parameters

path.participant_id · Any

DM を受信する相手ユーザーの ID。

body.body · CreateByParticipantIdRequest

リクエストボディ

​

create_conversation

DM会話の作成 指定した参加者との新しいダイレクトメッセージ会話を開始します。 body: リクエストボディ :returns: レスポンスデータ :rtype: CreateConversationResponse

​

パラメータ

body.body · CreateConversationRequest

​

delete_events

DM イベントを削除 認証済みユーザーが所有している場合は、その id を指定して特定のダイレクトメッセージイベントを削除します。

​

パラメーター

path.event_id · Any

削除するダイレクトメッセージイベントのIDです。

​

戻り値

DeleteEventsResponse - レスポンスデータ

​

get_events

DMイベントを取得します すべての会話を対象に、最近のダイレクトメッセージイベントの一覧を取得します。

​

パラメーター

path.max_results · int or None · デフォルト: "None"

取得する結果の最大数。

path.pagination_token · Any or None · デフォルト: "None"

結果の特定の「ページ」を取得するために使用するパラメーター。

path.event_types · List or None · デフォルト: "None"

結果に含める event_types のセット。

path.dm_event_fields · List or None · デフォルト: "None"

表示する DmEvent フィールドをカンマ区切りで指定するリスト。

path.expansions · List or None · デフォルト: "None"

展開するフィールドをカンマ区切りで指定するリスト。

path.media_fields · List or None · デフォルト: "None"

表示する Media フィールドをカンマ区切りで指定するリスト。

path.user_fields · List or None · デフォルト: "None"

表示する User フィールドをカンマ区切りで指定するリスト。

path.tweet_fields · List or None · デフォルト: "None"

表示する Tweet フィールドをカンマ区切りで指定するリスト。

​

戻り値

IteratorGetEventsResponse

​

get_events_by_conversation_id

DM会話のイベントを取得します 特定のDM会話に含まれるダイレクトメッセージイベントを取得します。

​

パラメーター

path.id · Any

DM 会話の ID です。

path.max_results · int or None · デフォルト: "None"

結果の最大取得件数です。

path.pagination_token · Any or None · デフォルト: "None"

結果の特定の「ページ」を取得するために使用されるパラメーターです。

path.event_types · List or None · デフォルト: "None"

結果に含める event_types の集合です。

path.dm_event_fields · List or None · デフォルト: "None"

表示する DmEvent フィールドのカンマ区切りリストです。

path.expansions · List or None · デフォルト: "None"

展開するフィールドのカンマ区切りリストです。

path.media_fields · List or None · デフォルト: "None"

表示する Media フィールドのカンマ区切りリストです。

path.user_fields · List or None · デフォルト: "None"

表示する User フィールドのカンマ区切りリストです。

path.tweet_fields · List or None · デフォルト: "None"

表示する Tweet フィールドのカンマ区切りリストです。

​

戻り値

IteratorGetEventsByConversationIdResponse

​

get_events_by_id

ID を指定して DM イベントを取得 指定した DM イベントを、その ID によって取得し、詳細を返します。

​

Parameters

path.event_id · Any

DM イベントの id。

path.dm_event_fields · List or None · デフォルト: "None"

表示する DmEvent のフィールドを指定するカンマ区切りのリスト。

path.expansions · List or None · デフォルト: "None"

expansions で展開するフィールドのカンマ区切りのリスト。

path.media_fields · List or None · デフォルト: "None"

表示する Media のフィールドを指定するカンマ区切りのリスト。

path.user_fields · List or None · デフォルト: "None"

表示する User のフィールドを指定するカンマ区切りのリスト。

path.tweet_fields · List or None · デフォルト: "None"

表示する Tweet のフィールドを指定するカンマ区切りのリスト。

​

戻り値

GetEventsByIdResponse - レスポンスデータ

​

get_events_by_participant_id

特定のDM会話のイベントを取得します 特定のDM会話におけるダイレクトメッセージイベントを取得します。

​

パラメーター

path.participant_id · Any

1対1のDM会話の参加ユーザーのID。

path.max_results · int or None · デフォルト: "None"

結果の最大数。

path.pagination_token · Any or None · デフォルト: "None"

結果の特定の「ページ」を取得するために使用するパラメーター。

path.event_types · List or None · デフォルト: "None"

結果に含める event_types のセット。

path.dm_event_fields · List or None · デフォルト: "None"

表示する DmEvent フィールドのカンマ区切りリスト。

path.expansions · List or None · デフォルト: "None"

展開するフィールドのカンマ区切りリスト。

path.media_fields · List or None · デフォルト: "None"

表示する Media フィールドのカンマ区切りリスト。

path.user_fields · List or None · デフォルト: "None"

表示する User フィールドのカンマ区切りリスト。

path.tweet_fields · List or None · デフォルト: "None"

表示する Tweet フィールドのカンマ区切りリスト。

​

戻り値

IteratorGetEventsByParticipantIdResponse