Invite
@discordeno/bot • Docs
Documentation / @discordeno/bot / Invite
Interface: Invite
Properties
approximateMemberCount
approximateMemberCount:
number
Approximate count of online members (only present when target_user is set)
Defined in
packages/bot/src/transformers/types.ts:1007
approximatePresenceCount?
optionalapproximatePresenceCount:number
Approximate count of online members (only present when target_user is set)
Defined in
packages/bot/src/transformers/types.ts:1015
channelId
channelId:
bigint
The channel the invite is for
Defined in
packages/bot/src/transformers/types.ts:983
code
code:
string
The unique invite code
Defined in
packages/bot/src/transformers/types.ts:985
createdAt
createdAt:
number
The time at which the invite was created
Defined in
packages/bot/src/transformers/types.ts:987
expiresAt?
optionalexpiresAt:number
The expiration date of this invite, returned from the GET /invites/code endpoint when with_expiration is true
Defined in
packages/bot/src/transformers/types.ts:1011
guildId?
optionalguildId:bigint
The guild of the invite
Defined in
packages/bot/src/transformers/types.ts:989
guildScheduledEvent?
optionalguildScheduledEvent:ScheduledEvent
guild scheduled event data
Defined in
packages/bot/src/transformers/types.ts:1013
inviter?
optionalinviter:User
The user that created the invite
Defined in
packages/bot/src/transformers/types.ts:991
maxAge
maxAge:
number
How long the invite is valid for (in seconds)
Defined in
packages/bot/src/transformers/types.ts:993
maxUses
maxUses:
number
The maximum number of times the invite can be used
Defined in
packages/bot/src/transformers/types.ts:995
stageInstance?
optionalstageInstance:InviteStageInstance
Stage instance data if there is a public Stage instance in the Stage channel this invite is for
Defined in
packages/bot/src/transformers/types.ts:1009
targetApplication?
optionaltargetApplication:Application
The embedded application to open for this voice channel embedded application invite
Defined in
packages/bot/src/transformers/types.ts:1001
targetType
targetType:
number
The type of target for this voice channel invite
Defined in
packages/bot/src/transformers/types.ts:997
targetUser
targetUser:
User
The target user for this invite
Defined in
packages/bot/src/transformers/types.ts:999
temporary
temporary:
boolean
Whether or not the invite is temporary (invited users will be kicked on disconnect unless they're assigned a role)
Defined in
packages/bot/src/transformers/types.ts:1003
type
type:
DiscordInviteType
The type of invite
Defined in
packages/bot/src/transformers/types.ts:981
uses
uses:
number
How many times the invite has been used (always will be 0)