Invite

@discordeno/bot

---

Documentation / @discordeno/bot / Invite

Interface: Invite

Defined in: packages/bot/src/transformers/types.ts:1038

Properties

approximateMemberCount

approximateMemberCount: number

Defined in: packages/bot/src/transformers/types.ts:1066

Approximate count of online members (only present when target_user is set)

---

approximatePresenceCount?

optional approximatePresenceCount: number

Defined in: packages/bot/src/transformers/types.ts:1074

Approximate count of online members (only present when target_user is set)

---

channelId

channelId: bigint

Defined in: packages/bot/src/transformers/types.ts:1042

The channel the invite is for

---

code

code: string

Defined in: packages/bot/src/transformers/types.ts:1044

The unique invite code

---

createdAt

createdAt: number

Defined in: packages/bot/src/transformers/types.ts:1046

The time at which the invite was created

---

expiresAt?

optional expiresAt: number

Defined in: packages/bot/src/transformers/types.ts:1070

The expiration date of this invite, returned from the GET /invites/code endpoint when with_expiration is true

---

guildId?

optional guildId: bigint

Defined in: packages/bot/src/transformers/types.ts:1048

The guild of the invite

---

guildScheduledEvent?

optional guildScheduledEvent: ScheduledEvent

Defined in: packages/bot/src/transformers/types.ts:1072

guild scheduled event data

---

inviter?

optional inviter: User

Defined in: packages/bot/src/transformers/types.ts:1050

The user that created the invite

---

maxAge

maxAge: number

Defined in: packages/bot/src/transformers/types.ts:1052

How long the invite is valid for (in seconds)

---

maxUses

maxUses: number

Defined in: packages/bot/src/transformers/types.ts:1054

The maximum number of times the invite can be used

---

stageInstance?

optional stageInstance: InviteStageInstance

Defined in: packages/bot/src/transformers/types.ts:1068

Stage instance data if there is a public Stage instance in the Stage channel this invite is for

---

targetApplication?

optional targetApplication: Application

Defined in: packages/bot/src/transformers/types.ts:1060

The embedded application to open for this voice channel embedded application invite

---

targetType

targetType: number

Defined in: packages/bot/src/transformers/types.ts:1056

The type of target for this voice channel invite

---

targetUser

targetUser: User

Defined in: packages/bot/src/transformers/types.ts:1058

The target user for this invite

---

temporary

temporary: boolean

Defined in: packages/bot/src/transformers/types.ts:1062

Whether or not the invite is temporary (invited users will be kicked on disconnect unless they're assigned a role)

---

type

type: DiscordInviteType

Defined in: packages/bot/src/transformers/types.ts:1040

The type of invite

---

uses

uses: number

Defined in: packages/bot/src/transformers/types.ts:1064

How many times the invite has been used (always will be 0)