> ## Documentation Index
> Fetch the complete documentation index at: https://generaltranslation.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# CommunitiesClient

Client pour les opérations relatives aux communautés

Ce client fournit des méthodes pour interagir avec les endpoints des communautés
de la X API. Il gère l’authentification, le formatage des requêtes et
l’analyse des réponses pour toutes les opérations liées aux communautés.

<div id="constructors">
  ## Constructeurs
</div>

<div id="constructor">
  ### constructor
</div>

• **new CommunitiesClient**(`client`): [`CommunitiesClient`](/fr/xdks/typescript/reference/classes/CommunitiesClient)

Crée une nouvelle instance de `CommunitiesClient`

<div id="parameters">
  #### Paramètres
</div>

| Nom      | Type                                                     | Description                           |
| :------- | :------------------------------------------------------- | :------------------------------------ |
| `client` | [`Client`](/fr/xdks/typescript/reference/classes/Client) | L'instance principale du client X API |

<div id="returns">
  #### Renvoie
</div>

[`CommunitiesClient`](/fr/xdks/typescript/reference/classes/CommunitiesClient)

<div id="defined-in">
  #### Défini dans
</div>

[communities/client.ts:102](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/communities/client.ts#L102)

<div id="methods">
  ## Méthodes
</div>

<div id="search">
  ### search
</div>

▸ **search**(`query`, `options`): `Promise`\<`Response`>

Recherche de communautés
Récupère une liste de communautés correspondant à la requête de recherche fournie.

<div id="parameters">
  #### Paramètres
</div>

| Nom       | Type                                                          | Description                                       |
| :-------- | :------------------------------------------------------------ | :------------------------------------------------ |
| `query`   | `string`                                                      | Requête permettant de rechercher des communautés. |
| `options` | `SearchOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                                 |

<div id="returns">
  #### Renvoie
</div>

`Promise`\<`Response`>

Promise qui se résout avec la réponse de l’API, ou avec l’objet `Response` brut si `requestOptions.raw` vaut `true`

<div id="defined-in">
  #### Défini dans
</div>

[communities/client.ts:147](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/communities/client.ts#L147)

▸ **search**(`query`, `options?`): `Promise`\<[`Get2CommunitiesSearchResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.Get2CommunitiesSearchResponse)>

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type            |
| :--------- | :-------------- |
| `query`    | `string`        |
| `options?` | `SearchOptions` |

<div id="returns">
  #### Renvoie
</div>

`Promise`\<[`Get2CommunitiesSearchResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.Get2CommunitiesSearchResponse)>

<div id="defined-in">
  #### Défini dans
</div>

[communities/client.ts:160](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/communities/client.ts#L160)

***

<div id="getbyid">
  ### getById
</div>

▸ **getById**(`id`, `options`): `Promise`\<`Response`>

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

<div id="parameters">
  #### Paramètres
</div>

| Nom       | Type                                                           | Description                     |
| :-------- | :------------------------------------------------------------- | :------------------------------ |
| `id`      | `string`                                                       | L’identifiant de la communauté. |
| `options` | `GetByIdOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                               |

<div id="returns">
  #### Renvoie
</div>

`Promise`\<`Response`>

Promise se résolvant en la réponse de l’API, ou l’objet Response brut si `requestOptions.raw` vaut `true`

<div id="defined-in">
  #### Défini dans
</div>

[communities/client.ts:352](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/communities/client.ts#L352)

▸ **getById**(`id`, `options?`): `Promise`\<[`Get2CommunitiesIdResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.Get2CommunitiesIdResponse)>

<div id="parameters">
  #### Paramètres
</div>

| Nom        | Type             |
| :--------- | :--------------- |
| `id`       | `string`         |
| `options?` | `GetByIdOptions` |

<div id="returns">
  #### Renvoie
</div>

`Promise`\<[`Get2CommunitiesIdResponse`](/fr/xdks/typescript/reference/interfaces/Schemas.Get2CommunitiesIdResponse)>

<div id="defined-in">
  #### Défini dans
</div>

[communities/client.ts:365](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/communities/client.ts#L365)