Submódulos
- xdk.direct_messages.client module
DirectMessagesClientDirectMessagesClient.__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 module
CreateByConversationIdRequestCreateByConversationIdResponseCreateByParticipantIdRequestCreateByParticipantIdResponseCreateConversationRequestCreateConversationResponseDeleteEventsResponseGetEventsByConversationIdResponseGetEventsByIdResponseGetEventsByParticipantIdResponseGetEventsResponse
Contenido del módulo
This module provides access to the direct messages endpoints of the X API and serves as the main entry point for all direct messages-related functionality.class xdk.direct_messages.DirectMessagesClient
Cliente para operaciones de direct messages
Parámetros
Client
__init__
Parámetros
Client
create_by_conversation_id
Create DM message by conversation ID
Sends a new direct message to a specific conversation by its ID.
Parámetros
str
The DM Conversation ID.
CreateByConversationIdRequest
Request body
create_by_participant_id
Create DM message by participant ID
Sends a new direct message to a specific participant by their ID.
Parámetros
Any
The ID of the recipient user that will receive the DM.
CreateByParticipantIdRequest
Request body
create_conversation
Create DM conversation
Initiates a new direct message conversation with specified participants.
body: Cuerpo de la solicitud
:returns: Datos de respuesta
:rtype: CreateConversationResponse
Parámetros
CreateConversationRequest
delete_events
Delete DM event
Deletes a specific direct message event by its ID, if owned by the authenticated user.
Parámetros
Any
The ID of the direct-message event to delete.
Devuelve
DeleteEventsResponse - Response data
get_events
Get DM events
Retrieves a list of recent direct message events across all conversations.
Parámetros
int or None
default:"None"
El número máximo de resultados.
Any or None
default:"None"
This parameter is used to get a specified ‘page’ of results.
List or None
default:"None"
The set of event_types to include in the results.
List or None
default:"None"
Una lista separada por comas de campos de DmEvent a mostrar.
List or None
default:"None"
Una lista separada por comas de campos para expandir.
List or None
default:"None"
Una lista separada por comas de campos de Media a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de User a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de Tweet a mostrar.
Devuelve
IteratorGetEventsResponse
get_events_by_conversation_id
Get DM events for a DM conversation
Retrieves direct message events for a specific conversation.
Parámetros
Any
The DM conversation ID.
int or None
default:"None"
El número máximo de resultados.
Any or None
default:"None"
This parameter is used to get a specified ‘page’ of results.
List or None
default:"None"
The set of event_types to include in the results.
List or None
default:"None"
Una lista separada por comas de campos de DmEvent a mostrar.
List or None
default:"None"
Una lista separada por comas de campos para expandir.
List or None
default:"None"
Una lista separada por comas de campos de Media a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de User a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de Tweet a mostrar.
Devuelve
IteratorGetEventsByConversationIdResponse
get_events_by_id
Get DM event by ID
Retrieves details of a specific direct message event by its ID.
Parámetros
Any
dm event id.
List or None
default:"None"
Una lista separada por comas de campos de DmEvent a mostrar.
List or None
default:"None"
Una lista separada por comas de campos para expandir.
List or None
default:"None"
Una lista separada por comas de campos de Media a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de User a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de Tweet a mostrar.
Devuelve
GetEventsByIdResponse - Response data
get_events_by_participant_id
Get DM events for a DM conversation
Retrieves direct message events for a specific conversation.
Parámetros
Any
The ID of the participant user for the One to One DM conversation.
int or None
default:"None"
El número máximo de resultados.
Any or None
default:"None"
This parameter is used to get a specified ‘page’ of results.
List or None
default:"None"
The set of event_types to include in the results.
List or None
default:"None"
Una lista separada por comas de campos de DmEvent a mostrar.
List or None
default:"None"
Una lista separada por comas de campos para expandir.
List or None
default:"None"
Una lista separada por comas de campos de Media a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de User a mostrar.
List or None
default:"None"
Una lista separada por comas de campos de Tweet a mostrar.
Devuelve
IteratorGetEventsByParticipantIdResponse