Saltar al contenido principal

​
Submódulos

​
Contenido del módulo

Este módulo proporciona acceso a los endpoints de comunidades de la X API y sirve como punto de entrada principal para todas las funciones relacionadas con comunidades.

​
class xdk.communities.CommunitiesClient

Client para operaciones relacionadas con comunidades

​
Parámetros

​
path.client
Client

​
__init__

​
Parámetros

​
path.client
Client

​
get_by_id

Obtener Community por id Obtiene los detalles de una Community específica por su id.

​
Parámetros

​
path.id
Any
El identificador de la Comunidad.
​
path.community_fields
List or None
predeterminado:"None"
Una lista de campos de Comunidad separados por comas para mostrar.

​
Devuelve

GetByIdResponse - Datos de respuesta Buscar comunidades Obtiene una lista de comunidades que coinciden con la consulta de búsqueda especificada.

​
Parámetros

​
path.query
str
Consulta para buscar comunidades.
​
path.max_results
int or None
predeterminado:"None"
La cantidad máxima de resultados de búsqueda que se devolverán en una solicitud.
​
path.next_token
Any or None
predeterminado:"None"
Este parámetro se usa para obtener la siguiente «página» de resultados. El valor usado con el parámetro se extrae directamente de la respuesta proporcionada por la API y no se debe modificar.
​
path.pagination_token
Any or None
predeterminado:"None"
Este parámetro se usa para obtener la siguiente «página» de resultados. El valor usado con el parámetro se extrae directamente de la respuesta proporcionada por la API y no se debe modificar.
​
path.community_fields
List or None
predeterminado:"None"
Una lista separada por comas de campos de Comunidad que se mostrarán.

​
Valores de retorno

IteratorSearchResponse