DirectMessagesClient

ダイレクトメッセージ操作用クライアント

このクライアントは、X API のダイレクトメッセージ関連エンドポイントとやり取りするためのメソッドを提供します。認証、リクエストの整形、レスポンスの解析を担い、ダイレクトメッセージに関する各種操作をサポートします。

​

コンストラクタ

​

constructor

• new DirectMessagesClient(client): DirectMessagesClient

新しいダイレクトメッセージクライアントのインスタンスを生成します

​

パラメータ

名前	型	説明
client	Client	X API のメインクライアントインスタンス

​

戻り値

DirectMessagesClient

​

定義場所

direct_messages/client.ts:211

​

メソッド

​

getEvents

▸ getEvents(options?): Promise<Get2DmEventsResponse>

DM イベントを取得 すべての会話にわたる直近のダイレクトメッセージイベントの一覧を取得します。

​

パラメーター

名称	型
options	GetEventsOptions

​

戻り値

Promise<Get2DmEventsResponse>

API レスポンスを解決する Promise

​

定義箇所

direct_messages/client.ts:224

---

​

getEventsByParticipantId

▸ getEventsByParticipantId(participantId, options?): Promise<Get2DmConversationsWithParticipantIdDmEventsResponse>

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

​

パラメーター

名前	型	説明
participantId	string	1対1のDM会話における参加ユーザーのid。
options	GetEventsByParticipantIdOptions	-

​

返り値

Promise<Get2DmConversationsWithParticipantIdDmEventsResponse>

API レスポンスを返す Promise

​

定義箇所

direct_messages/client.ts:311

---

​

createByConversationId

▸ createByConversationId(dmConversationId, options?): Promise<CreateDmEventResponse>

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

​

パラメータ

名前	型	説明
dmConversationId	string	DM会話ID。
options	CreateByConversationIdOptions	-

​

戻り値

Promise<CreateDmEventResponse>

API レスポンスで解決される Promise

​

定義箇所

direct_messages/client.ts:406

---

​

createByParticipantId

▸ createByParticipantId(participantId, options?): Promise<CreateDmEventResponse>

参加者IDでDMメッセージを作成 指定した参加者のID宛てに新規ダイレクトメッセージを送信します。

​

パラメータ

名前	型	説明
participantId	string	DM を受信する相手ユーザーの id。
options	CreateByParticipantIdOptions	-

​

戻り値

Promise<CreateDmEventResponse>

API レスポンスで解決される Promise

​

定義箇所

direct_messages/client.ts:457

---

​

getEventsByConversationId

▸ getEventsByConversationId(id, options?): Promise<Get2DmConversationsIdDmEventsResponse>

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

​

パラメータ

名前	型	説明
id	string	DM会話のID。
options	GetEventsByConversationIdOptions	-

​

返り値

Promise<Get2DmConversationsIdDmEventsResponse>

API レスポンスで解決される Promise

​

定義箇所

direct_messages/client.ts:508

---

​

getEventsById

▸ getEventsById(eventId, options?): Promise<Get2DmEventsEventIdResponse>

IDでDMイベントを取得 指定したIDのダイレクトメッセージイベントの詳細を取得します。

​

パラメータ

名前	型	説明
eventId	string	DMイベントのid。
options	GetEventsByIdOptions	-

​

戻り値

Promise<Get2DmEventsEventIdResponse>

API レスポンスで解決される Promise

​

定義箇所

direct_messages/client.ts:600

---

​

deleteEvents

▸ deleteEvents(eventId): Promise<DeleteDmResponse>

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

​

パラメータ

名前	型	説明
eventId	string	削除対象のダイレクトメッセージイベントのID。

​

戻り値

Promise<DeleteDmResponse>

API レスポンスを返す Promise

​

定義箇所

direct_messages/client.ts:674

---

​

createConversation

▸ createConversation(options?): Promise<CreateDmEventResponse>

DM会話を作成 指定した参加者との新規ダイレクトメッセージ会話を開始します。

​

パラメーター

名前	型
options	CreateConversationOptions

​

戻り値

Promise<CreateDmEventResponse>

API レスポンスを返す Promise

​

定義元

direct_messages/client.ts:708