Skip to main content
Client para operações de direct messages Este client fornece métodos para interagir com os endpoints direct messages da X API. Ele cuida da autenticação, formatação de requisição e análise de resposta para todas as operações relacionadas a direct messages.

Construtores

constructor

new DirectMessagesClient(client): DirectMessagesClient Cria uma nova instância do client direct messages

Parâmetros

Retorna

DirectMessagesClient

Definido em

direct_messages/client.ts:340

Métodos

createByConversationId

createByConversationId(dmConversationId, options): Promise<Response> Create DM message by conversation ID Sends a new direct message to a specific conversation by its ID.

Parâmetros

Retorna

Promise<Response> Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true

Definido em

direct_messages/client.ts:385 createByConversationId(dmConversationId, options?): Promise<CreateDmEventResponse>

Parâmetros

Retorna

Promise<CreateDmEventResponse>

Definido em

direct_messages/client.ts:398

getEventsByConversationId

getEventsByConversationId(id, options): Promise<Response> Get DM events for a DM conversation Retrieves direct message events for a specific conversation.

Parâmetros

Retorna

Promise<Response> Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true

Definido em

direct_messages/client.ts:506 getEventsByConversationId(id, options?): Promise<Get2DmConversationsIdDmEventsResponse>

Parâmetros

Retorna

Promise<Get2DmConversationsIdDmEventsResponse>

Definido em

direct_messages/client.ts:519

createConversation

createConversation(options): Promise<Response> Create DM conversation Initiates a new direct message conversation with specified participants.

Parâmetros

Retorna

Promise<Response> Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true

Definido em

direct_messages/client.ts:784 createConversation(options?): Promise<CreateDmEventResponse>

Parâmetros

Retorna

Promise<CreateDmEventResponse>

Definido em

direct_messages/client.ts:793

getEventsByParticipantId

getEventsByParticipantId(participantId, options): Promise<Response> Get DM events for a DM conversation Retrieves direct message events for a specific conversation.

Parâmetros

Retorna

Promise<Response> Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true

Definido em

direct_messages/client.ts:889 getEventsByParticipantId(participantId, options?): Promise<Get2DmConversationsWithParticipantIdDmEventsResponse>

Parâmetros

Retorna

Promise<Get2DmConversationsWithParticipantIdDmEventsResponse>

Definido em

direct_messages/client.ts:902

getEvents

getEvents(options): Promise<Response> Get DM events Retrieves a list of recent direct message events across all conversations.

Parâmetros

Retorna

Promise<Response> Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true

Definido em

direct_messages/client.ts:1167 getEvents(options?): Promise<Get2DmEventsResponse>

Parâmetros

Retorna

Promise<Get2DmEventsResponse>

Definido em

direct_messages/client.ts:1176

getEventsById

getEventsById(eventId, options): Promise<Response> Get DM event by ID Retrieves details of a specific direct message event by its ID.

Parâmetros

Retorna

Promise<Response> Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true

Definido em

direct_messages/client.ts:1433 getEventsById(eventId, options?): Promise<Get2DmEventsEventIdResponse>

Parâmetros

Retorna

Promise<Get2DmEventsEventIdResponse>

Definido em

direct_messages/client.ts:1446

deleteEvents

deleteEvents(eventId, options): Promise<Response> Delete DM event Deletes a specific direct message event by its ID, if owned by the authenticated user.

Parâmetros

Retorna

Promise<Response> Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true

Definido em

direct_messages/client.ts:1656 deleteEvents(eventId): Promise<DeleteDmResponse>

Parâmetros

Retorna

Promise<DeleteDmResponse>

Definido em

direct_messages/client.ts:1669

createByParticipantId

createByParticipantId(participantId, options): Promise<Response> Create DM message by participant ID Sends a new direct message to a specific participant by their ID.

Parâmetros

Retorna

Promise<Response> Promise que resolve para a resposta da API, ou Response bruto se requestOptions.raw for true

Definido em

direct_messages/client.ts:1760 createByParticipantId(participantId, options?): Promise<CreateDmEventResponse>

Parâmetros

Retorna

Promise<CreateDmEventResponse>

Definido em

direct_messages/client.ts:1773