CommunitiesClient

​

CommunitiesClient

Classe Bases : object

Client pour les opérations relatives aux communautés

​

Constructeurs

​

__init__

​

Paramètres

path.client · Client

​

get_by_id

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

​

Paramètres

path.id · Any

L’identifiant de la Communauté.

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

Une liste, séparée par des virgules, de champs de Communauté à afficher.

​

Renvoie

GetByIdResponse - Données de la 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 utilisée pour rechercher des communautés.

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

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

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

Ce paramètre est utilisé pour obtenir la « page » suivante de résultats. La valeur utilisée avec le 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 obtenir la « page » suivante de résultats. La valeur utilisée avec le 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"

Une liste de champs Community séparée par des virgules à afficher.

​

Valeur de retour

IteratorSearchResponse