Skip to main content

​
Submódulos

​
Contenido del módulo

This module provides access to the lists endpoints of the X API and serves as the main entry point for all lists-related functionality.

​
class xdk.lists.ListsClient

Cliente para operaciones de lists

​
Parámetros

​
Client

​
__init__

​
Parámetros

​
Client

​
add_member

Add List member Adds a User to a specific List by its ID.

​
Parámetros

​
Any
The ID of the List for which to add a member.
​
AddMemberRequest
Request body

​
create

Create List Creates a new List for the authenticated user. body: Cuerpo de la solicitud :returns: Datos de respuesta :rtype: CreateResponse

​
Parámetros

​
CreateRequest

​
delete

Delete List Deletes a specific List owned by the authenticated user by its ID.

​
Parámetros

​
Any
The ID of the List to delete.

​
Devuelve

DeleteResponse - Response data

​
get_by_id

Get List by ID Retrieves details of a specific List by its ID.

​
Parámetros

​
Any
The ID of the List.
​
List or None
default:"None"
Una lista separada por comas de campos de List 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 User a mostrar.

​
Devuelve

GetByIdResponse - Response data

​
get_followers

Get List followers Retrieves a list of Users who follow a specific List by its ID.

​
Parámetros

​
Any
The ID of the List.
​
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"
Una lista separada por comas de campos de User 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 Tweet a mostrar.

​
Devuelve

IteratorGetFollowersResponse

​
get_members

Get List members Retrieves a list of Users who are members of a specific List by its ID.

​
Parámetros

​
Any
The ID of the List.
​
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"
Una lista separada por comas de campos de User 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 Tweet a mostrar.

​
Devuelve

IteratorGetMembersResponse

​
get_posts

Get List Posts Retrieves a list of Posts associated with a specific List by its ID.

​
Parámetros

​
Any
The ID of the List.
​
int or None
default:"None"
El número máximo de resultados.
​
Any or None
default:"None"
This parameter is used to get the next ‘page’ of results.
​
List or None
default:"None"
Una lista separada por comas de campos de Tweet 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 Poll 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 Place a mostrar.

​
Devuelve

IteratorGetPostsResponse

​
remove_member_by_user_id

Remove List member Removes a User from a specific List by its ID and the User’s ID.

​
Parámetros

​
Any
The ID of the List to remove a member.
​
Any
The ID of User that will be removed from the List.

​
Devuelve

RemoveMemberByUserIdResponse - Response data

​
update

Update List Updates the details of a specific List owned by the authenticated user by its ID.

​
Parámetros

​
Any
The ID of the List to modify.
​
UpdateRequest
Request body