Submódulos
- Módulo xdk.users.client
UsersClientUsersClient.__init__()UsersClient.block_dms()UsersClient.create_bookmark()UsersClient.delete_bookmark()UsersClient.follow_list()UsersClient.follow_user()UsersClient.get_blocking()UsersClient.get_bookmark_folders()UsersClient.get_bookmarks()UsersClient.get_bookmarks_by_folder_id()UsersClient.get_by_id()UsersClient.get_by_ids()UsersClient.get_by_username()UsersClient.get_by_usernames()UsersClient.get_followed_lists()UsersClient.get_followers()UsersClient.get_following()UsersClient.get_liked_posts()UsersClient.get_list_memberships()UsersClient.get_me()UsersClient.get_mentions()UsersClient.get_muting()UsersClient.get_owned_lists()UsersClient.get_pinned_lists()UsersClient.get_posts()UsersClient.get_reposts_of_me()UsersClient.get_timeline()UsersClient.like_post()UsersClient.mute_user()UsersClient.pin_list()UsersClient.repost_post()UsersClient.search()UsersClient.unblock_dms()UsersClient.unfollow_list()UsersClient.unfollow_user()UsersClient.unlike_post()UsersClient.unmute_user()UsersClient.unpin_list()UsersClient.unrepost_post()
- Módulo xdk.users.models
BlockDmsResponseCreateBookmarkRequestCreateBookmarkResponseDeleteBookmarkResponseFollowListRequestFollowListResponseFollowUserRequestFollowUserResponseGetBlockingResponseGetBookmarkFoldersResponseGetBookmarksByFolderIdResponseGetBookmarksResponseGetByIdResponseGetByIdsResponseGetByUsernameResponseGetByUsernamesResponseGetFollowedListsResponseGetFollowersResponseGetFollowingResponseGetLikedPostsResponseGetListMembershipsResponseGetMeResponseGetMentionsResponseGetMutingResponseGetOwnedListsResponseGetPinnedListsResponseGetPostsResponseGetRepostsOfMeResponseGetTimelineResponseLikePostRequestLikePostResponseMuteUserRequestMuteUserResponsePinListRequestPinListResponseRepostPostRequestRepostPostResponseSearchResponseUnblockDmsResponseUnfollowListResponseUnfollowUserResponseUnlikePostResponseUnmuteUserResponseUnpinListResponseUnrepostPostResponse
Contenido del módulo
class xdk.users.UsersClient
Parámetros
__init__
Parámetros
block_dms
Parámetros
El identificador del Usuario de destino del que el usuario autenticado solicita bloquear los mensajes directos.
Devuelve
BlockDmsResponse - Datos de la respuesta
create_bookmark
Parámetros
El identificador del Usuario de origen autenticado para el que se agregarán marcadores.
Cuerpo de la solicitud
delete_bookmark
Parámetros
El identificador del Usuario de origen autenticado cuyo marcador se va a eliminar.
El identificador de la Publicación que el Usuario de origen está quitando de sus marcadores.
Devuelve
DeleteBookmarkResponse - Datos de respuesta
follow_list
Parámetros
El identificador del Usuario de origen autenticado que seguirá la Lista.
Cuerpo de la solicitud
follow_user
Parámetros
El identificador del Usuario de origen autenticado que solicita seguir al Usuario de destino.
Cuerpo de la solicitud
get_blocking
Parámetros
El ID del Usuario de origen autenticado para el cual se devolverán los resultados.
El número máximo de resultados.
Este parámetro se utiliza para obtener una página específica de resultados.
Una lista separada por comas de campos de Usuario que se mostrarán.
Una lista separada por comas de campos para expandir.
Una lista separada por comas de campos de Tweet que se mostrarán.
Valor de retorno
IteratorGetBlockingResponse
get_bookmark_folders
Obtiene una lista de carpetas de marcadores creadas por el usuario autenticado.
Parámetros
El ID del usuario de origen autenticado para el que se devolverán resultados.
El número máximo de resultados.
Este parámetro se utiliza para obtener la siguiente “página” de resultados.
Devuelve
IteratorGetBookmarkFoldersResponse
get_bookmarks
Parámetros
El ID del Usuario de origen autenticado para el que se devolverán resultados.
El número máximo de resultados.
Este parámetro se utiliza para obtener la siguiente «página» de resultados.
Una lista de campos de Tweet, separados por comas, que se mostrarán.
Una lista de campos, separados por comas, que se deben expandir.
Una lista de campos de Media, separados por comas, que se mostrarán.
Una lista de campos de Poll, separados por comas, que se mostrarán.
Una lista de campos de User, separados por comas, que se mostrarán.
Una lista de campos de Place, separados por comas, que se mostrarán.
Devuelve
IteratorGetBookmarksResponse
get_bookmarks_by_folder_id
Parámetros
El id del Usuario de origen autenticado para el cual se devolverán los resultados.
El id de la Carpeta de Marcadores de la que el Usuario autenticado intenta obtener Publicaciones.
Devuelve
GetBookmarksByFolderIdResponse - Datos de la respuesta
get_by_id
Parámetros
El id del usuario que se va a buscar.
Una lista separada por comas de campos de usuario que se van a mostrar.
Una lista separada por comas de campos que se van a expandir.
Una lista separada por comas de campos de Tweet que se van a mostrar.
Devuelve
GetByIdResponse - Datos de respuesta
get_by_ids
Parameters
Una lista de id de usuario separados por comas. Puedes especificar hasta 100 id.
Una lista separada por comas de campos de usuario para mostrar.
Una lista separada por comas de campos para expandir.
Una lista separada por comas de campos de Tweet para mostrar.
Devuelve
GetByIdsResponse - Datos de respuesta
get_by_username
Parámetros
Un nombre de usuario.
Una lista de campos de usuario, separados por comas, que se mostrarán.
Una lista de campos, separados por comas, que se expandirán.
Una lista de campos de Tweet, separados por comas, que se mostrarán.
Devuelve
GetByUsernameResponse - Datos de la respuesta
get_by_usernames
Parámetros
Una lista de nombres de usuario separados por comas.
Una lista separada por comas de campos de usuario que se van a mostrar.
Una lista separada por comas de campos que se deben expandir.
Una lista separada por comas de campos de Tweet que se van a mostrar.
Devuelve
GetByUsernamesResponse - Datos de respuesta
get_followed_lists
Parámetros
El identificador del usuario que se va a consultar.
El número máximo de resultados.
Este parámetro se utiliza para obtener una “página” específica de resultados.
Una lista separada por comas de campos de lista que se van a mostrar.
Una lista separada por comas de campos que se van a expandir.
Una lista separada por comas de campos de usuario que se van a mostrar.
Devuelve
IteratorGetFollowedListsResponse
get_followers
Parámetros
El identificador del usuario que se va a consultar.
El número máximo de resultados.
Este parámetro se utiliza para obtener una «página» específica de resultados.
Una lista de campos de usuario, separados por comas, para mostrar.
Una lista de campos, separados por comas, que se van a expandir.
Una lista de campos de Tweet, separados por comas, para mostrar.
Devuelve
IteratorGetFollowersResponse
get_following
Parámetros
El id del usuario que se va a consultar.
El número máximo de resultados.
Este parámetro se utiliza para obtener una “página” específica de resultados.
Una lista de campos de usuario separados por comas que se van a mostrar.
Una lista de campos separados por comas que se van a expandir.
Una lista de campos de Tweet separados por comas que se van a mostrar.
Devuelve
IteratorGetFollowingResponse
get_liked_posts
Parámetros
El identificador del usuario que se va a consultar.
El número máximo de resultados.
Este parámetro se usa para obtener la siguiente “página” de resultados.
Una lista separada por comas de campos de Tweet que se van a mostrar.
Una lista separada por comas de campos que se deben expandir.
Una lista separada por comas de campos de Media que se van a mostrar.
Una lista separada por comas de campos de Poll que se van a mostrar.
Una lista separada por comas de campos de User que se van a mostrar.
Una lista separada por comas de campos de Place que se van a mostrar.
Devuelve
IteratorGetLikedPostsResponse
get_list_memberships
Parámetros
El identificador del usuario que se va a consultar.
El número máximo de resultados.
Este parámetro se usa para obtener una ‘página’ específica de resultados.
Una lista separada por comas de campos de List que se mostrarán.
Una lista separada por comas de campos que se van a expandir.
Una lista separada por comas de campos de User que se mostrarán.
Devuelve
IteratorGetListMembershipsResponse
get_me
Parámetros
Una lista de campos de usuario, separados por comas, que se mostrarán.
Una lista de campos a expandir, separados por comas.
Una lista de campos de Tweet, separados por comas, que se mostrarán.
Devuelve
GetMeResponse - Datos de respuesta
get_mentions
Parámetros
El ID del usuario que se va a consultar.
El ID mínimo de la publicación que se incluirá en el conjunto de resultados. Este parámetro tiene prioridad sobre start_time si se especifican ambos.
El ID máximo de la publicación que se incluirá en el conjunto de resultados. Este parámetro tiene prioridad sobre end_time si se especifican ambos.
El número máximo de resultados.
Este parámetro se utiliza para obtener la siguiente “página” de resultados.
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más temprana a partir de la cual se proporcionarán las publicaciones. El parámetro since_id tiene prioridad si también se especifica.
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más reciente hasta la cual se proporcionarán las publicaciones. El parámetro until_id tiene prioridad si también se especifica.
Una lista separada por comas de campos de Tweet que se mostrarán.
Una lista separada por comas de campos que se expandirán.
Una lista separada por comas de campos de medios que se mostrarán.
Una lista separada por comas de campos de encuestas que se mostrarán.
Una lista separada por comas de campos de usuario que se mostrarán.
Una lista separada por comas de campos de lugar que se mostrarán.
Devuelve
IteratorGetMentionsResponse
get_muting
Parámetros
El id del Usuario de origen autenticado para el que se devolverán resultados.
El número máximo de resultados.
Este parámetro se utiliza para obtener la siguiente ‘página’ de resultados.
Una lista separada por comas de campos de Usuario para mostrar.
Una lista separada por comas de campos para expandir.
Una lista separada por comas de campos de Tweet para mostrar.
Devuelve
IteratorGetMutingResponse
get_owned_lists
Parámetros
El identificador del Usuario que se va a consultar.
El número máximo de resultados.
Este parámetro se usa para obtener una página específica de resultados.
Una lista, separada por comas, de campos de Lista que se mostrarán.
Una lista, separada por comas, de campos que se deben expandir.
Una lista, separada por comas, de campos de Usuario que se mostrarán.
Devuelve
IteratorGetOwnedListsResponse
get_pinned_lists
Parámetros
El identificador del Usuario de origen autenticado para el cual se devolverán los resultados.
Una lista de campos de Lista separados por comas que se mostrarán.
Una lista de campos separados por comas que se van a expandir.
Una lista de campos de Usuario separados por comas que se mostrarán.
Devuelve
GetPinnedListsResponse - Datos de respuesta
get_posts
Parámetros
El ID del usuario que se va a buscar.
El ID mínimo de la Publicación que se incluirá en el conjunto de resultados. Este parámetro tiene prioridad sobre start_time si se especifican ambos.
El ID máximo de la Publicación que se incluirá en el conjunto de resultados. Este parámetro tiene prioridad sobre end_time si se especifican ambos.
El número máximo de resultados.
Este parámetro se utiliza para obtener la siguiente «página» de resultados.
El conjunto de entidades que se deben excluir (por ejemplo, «replies» o «retweets»).
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más temprana a partir de la cual se proporcionarán las Publicaciones. El parámetro since_id tiene prioridad si también se especifica.
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más reciente hasta la cual se proporcionarán las Publicaciones. El parámetro until_id tiene prioridad si también se especifica.
Una lista separada por comas de campos de Tweet que se mostrarán.
Una lista separada por comas de campos que se van a expandir.
Una lista separada por comas de campos de medios que se mostrarán.
Una lista separada por comas de campos de encuesta que se mostrarán.
Una lista separada por comas de campos de usuario que se mostrarán.
Una lista separada por comas de campos de lugar que se mostrarán.
Devuelve
IteratorGetPostsResponse
get_reposts_of_me
Parámetros
El número máximo de resultados.
Este parámetro se usa para obtener la página siguiente de resultados.
Una lista de campos de Tweet, separados por comas, que se mostrarán.
Una lista de campos, separados por comas, que se expandirán.
Una lista de campos de Media, separados por comas, que se mostrarán.
Una lista de campos de Poll, separados por comas, que se mostrarán.
Una lista de campos de User, separados por comas, que se mostrarán.
Una lista de campos de Place, separados por comas, que se mostrarán.
Devuelve
IteratorGetRepostsOfMeResponse
get_timeline
Parámetros
El ID del Usuario de origen autenticado para listar sus Publicaciones de la cronología en orden cronológico inverso.
El ID mínimo de la Publicación que se incluirá en el conjunto de resultados. Este parámetro tiene prioridad sobre start_time si ambos se especifican.
El ID máximo de la Publicación que se incluirá en el conjunto de resultados. Este parámetro tiene prioridad sobre end_time si ambos se especifican.
El número máximo de resultados.
Este parámetro se utiliza para obtener la siguiente “página” de resultados.
El conjunto de entidades que se excluirán (por ejemplo, ‘replies’ o ‘retweets’).
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más temprana a partir de la cual se proporcionarán las Publicaciones. El parámetro since_id tiene prioridad si también se especifica.
YYYY-MM-DDTHH:mm:ssZ. La marca de tiempo UTC más reciente hasta la cual se proporcionarán las Publicaciones. El parámetro until_id tiene prioridad si también se especifica.
Una lista separada por comas de campos de Tweet que se mostrarán.
Una lista separada por comas de campos que se expandirán.
Una lista separada por comas de campos de medios que se mostrarán.
Una lista separada por comas de campos de encuestas que se mostrarán.
Una lista separada por comas de campos de Usuario que se mostrarán.
Una lista separada por comas de campos de lugares que se mostrarán.
Devuelve
IteratorGetTimelineResponse
like_post
Parámetros
El ID del usuario de origen autenticado que solicita dar Me gusta a la Publicación.
Cuerpo de la solicitud
mute_user
Parámetros
El ID del usuario de origen autenticado que solicita silenciar al usuario de destino.
Cuerpo de la solicitud
pin_list
Parámetros
El ID del Usuario de origen autenticado que fijará la Lista.
Cuerpo de la solicitud
repost_post
Parámetros
El ID del Usuario de origen autenticado que solicita republicar la Publicación.
Cuerpo de la solicitud
search
Parámetros
La cadena de consulta con la que realizar la búsqueda de usuarios.
El número máximo de resultados.
Este parámetro se usa para obtener la siguiente «página» de resultados. El valor usado con el parámetro se toma directamente de la respuesta proporcionada por la API y no se debe modificar.
Una lista, separada por comas, de campos de usuario que se van a mostrar.
Una lista, separada por comas, de campos que se van a expandir.
Una lista, separada por comas, de campos de Tweet que se van a mostrar.
Devuelve
IteratorSearchResponse
unblock_dms
Parámetros
El identificador (
id) del usuario de destino para el cual el usuario autenticado solicita desbloquear los DMs.Devuelve
UnblockDmsResponse - Datos de la respuesta
unfollow_list
Parámetros
El ID del Usuario de origen autenticado que dejará de seguir la Lista.
El ID de la Lista que se dejará de seguir.
Valores devueltos
UnfollowListResponse - Datos de la respuesta
unfollow_user
Parámetros
El ID del usuario de origen autenticado que solicita dejar de seguir al usuario de destino.
El ID del usuario al que el usuario de origen solicita dejar de seguir.
Valores devueltos
UnfollowUserResponse - Datos de la respuesta
unlike_post
Parámetros
El identificador del usuario de origen autenticado que solicita quitar el Me gusta de la Publicación.
El identificador de la Publicación de la que el usuario solicita quitar el Me gusta.
Devuelve
UnlikePostResponse - Datos de respuesta
unmute_user
Parámetros
El id del usuario de origen autenticado que solicita dejar de silenciar al usuario de destino.
El id del usuario al que el usuario de origen solicita dejar de silenciar.
Valores devueltos
UnmuteUserResponse - Datos de la respuesta
unpin_list
Parámetros
El identificador del usuario de origen autenticado para el cual se devolverán los resultados.
El identificador de la Lista que se va a desfijar.
Devuelve
UnpinListResponse - Datos de la respuesta
unrepost_post
Parámetros
El identificador del Usuario de origen autenticado que solicita volver a publicar la Publicación.
El identificador de la Publicación que el Usuario solicita dejar de retuitear.
Devuelve
UnrepostPostResponse - Datos de la respuesta