Skip to main content

CreateChannelInvite

@discordeno/botDocs


Documentation / @discordeno/bot / CreateChannelInvite

Interface: CreateChannelInvite

Properties

maxAge?

optional maxAge: number

Duration of invite in seconds before expiry, or 0 for never. Between 0 and 604800 (7 days). Default: 86400 (24 hours)

Defined in

packages/types/dist/types/discordeno.d.ts:1047


maxUses?

optional maxUses: number

Max number of users or 0 for unlimited. Between 0 and 100. Default: 0

Defined in

packages/types/dist/types/discordeno.d.ts:1049


targetApplicationId?

optional targetApplicationId: BigString

The id of the embedded application to open for this invite, required if target_type is 2, the application must have the EMBEDDED flag

Defined in

packages/types/dist/types/discordeno.d.ts:1059


targetType?

optional targetType: TargetTypes

The type of target for this voice channel invite

Defined in

packages/types/dist/types/discordeno.d.ts:1055


targetUserId?

optional targetUserId: BigString

The id of the user whose stream to display for this invite, required if target_type is 1, the user must be streaming in the channel

Defined in

packages/types/dist/types/discordeno.d.ts:1057


temporary?

optional temporary: boolean

Whether this invite only grants temporary membership. Default: false

Defined in

packages/types/dist/types/discordeno.d.ts:1051


unique?

optional unique: boolean

If true, don't try to reuse similar invite (useful for creating many unique one time use invites). Default: false

Defined in

packages/types/dist/types/discordeno.d.ts:1053