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

# Invite

> Lire le lien, les utilisations et l’expiration d’une invitation, et la supprimer

Une `Invite` est une invitation vers un serveur. Vous en obtenez une depuis `channel.createInvite()`, `channel.fetchInvites()` ou `guild.fetchInvites()`.

```ts theme={"theme":{"light":"github-light","dark":"vesper"}}
import type { TextChannel } from 'chapterjs';

async function invite(channel: TextChannel) {
  const invite = await channel.createInvite({ maxAge: 3600, maxUses: 1, unique: true });
  return invite.url; // https://discord.gg/...
}
```

> [!NOTE]
>
> Ce que prend `createInvite()` est dans [InviteCreateOptions](https://www.chapterjs.org/fr/reference/options.md#invitecreateoptions). Quels salons peuvent en créer une est dans [Salons](https://www.chapterjs.org/fr/reference/channels).

## Propriétés

**inviter** `User | null`

Qui a créé l’invitation, quand Discord le dit.

**code** `string`

Le code unique de l’invitation (`discord.gg/code`).

**url** `string`

Le lien à partager.

**guildId** `Snowflake | null`

L’identifiant du serveur vers lequel mène l’invitation.

**channelId** `Snowflake | null`

L’identifiant du salon vers lequel mène l’invitation.

**channel** `GuildChannel | null`

Le salon vers lequel mène l’invitation, quand le bot le connaît. N’envoie jamais de requête.

**expiresAt** `Date | null`

Quand l’invitation cesse de fonctionner ; `null` quand elle ne cesse jamais.

**uses** `number | null`

Combien de fois l’invitation a été utilisée, quand Discord le dit.

**maxUses** `number | null`

Combien de fois l’invitation peut être utilisée ; `0` veut dire pas de limite.

**temporary** `boolean`

Si les membres arrivés avec elle sont expulsés quand ils se déconnectent.

> [!NOTE]
>
> Une invitation n’a ni `id` ni `createdAt` : Discord l’identifie par son `code`.

## Helpers

Ils lisent ce dont le bot se souvient : ils n’envoient jamais de requête.

### toString()

```ts theme={"theme":{"light":"github-light","dark":"vesper"}}
toString(): string
```

Le lien à partager.

### toJSON()

```ts theme={"theme":{"light":"github-light","dark":"vesper"}}
toJSON(): object
```

Les données de Discord sous forme d’objet simple, avec des noms en camelCase.

## Actions

### delete()

```ts theme={"theme":{"light":"github-light","dark":"vesper"}}
delete(reason?: string): Promise<void>
```

Supprime l’invitation : son lien cesse de fonctionner.

[Documentation de Discord](https://docs.discord.com/developers/resources/invite#delete-invite)

## Types

`InviteCreateOptions` est dans [Options](https://www.chapterjs.org/fr/reference/options.md#invitecreateoptions).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.