CommunitiesClient

​

Sous-modules

• module xdk.communities.client
  • CommunitiesClient
    • CommunitiesClient.__init__()
    • CommunitiesClient.get_by_id()
    • CommunitiesClient.search()
• module xdk.communities.models
  • GetByIdResponse
    • GetByIdResponse.model_config
  • SearchResponse
    • SearchResponse.model_config

​

Contenu du module

Ce module permet d’accéder aux endpoints des communautés de la X API et sert de point d’entrée principal pour toutes les fonctionnalités liées aux communautés.

​

class xdk.communities.CommunitiesClient

Client pour les opérations relatives aux communautés

​

Paramètres

path.client · Client

​

__init__

​

Paramètres

path.client · Client

​

get_by_id

Récupérer une Community par id Récupère les détails d’une Community spécifique à partir de son id.

​

Paramètres

path.id · Any

L’identifiant de la Communauté.

path.community_fields · List or None · défaut: "None"

Liste de champs de Communauté, séparés par des virgules, à afficher.

​

Renvoie

GetByIdResponse - Données de réponse

​

search

Rechercher des communautés Renvoie une liste de communautés correspondant à la requête de recherche spécifiée.

​

Paramètres

path.query · str

Requête pour rechercher des communautés.

path.max_results · int or None · défaut: "None"

Nombre maximal de résultats de recherche à renvoyer dans une requête.

path.next_token · Any or None · défaut: "None"

Ce paramètre est utilisé pour récupérer la « page » de résultats suivante. La valeur utilisée avec ce paramètre est extraite directement de la réponse fournie par l’API et ne doit pas être modifiée.

path.pagination_token · Any or None · défaut: "None"

Ce paramètre est utilisé pour récupérer la « page » de résultats suivante. La valeur utilisée avec ce paramètre est extraite directement de la réponse fournie par l’API et ne doit pas être modifiée.

path.community_fields · List or None · défaut: "None"

Liste de champs Community à afficher, séparés par des virgules.

​

Renvoie

IteratorSearchResponse