Skip to main content

CreateChannelInvite

@discordeno/bot


Documentation / @discordeno/bot / CreateChannelInvite

Interface: CreateChannelInvite

Defined in: packages/types/dist/types/discordeno.d.ts:1045

Properties

maxAge?

optional maxAge: number

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

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


maxUses?

optional maxUses: number

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

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


targetApplicationId?

optional targetApplicationId: BigString

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

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


targetType?

optional targetType: TargetTypes

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

The type of target for this voice channel invite


targetUserId?

optional targetUserId: BigString

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

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


temporary?

optional temporary: boolean

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

Whether this invite only grants temporary membership. Default: false


unique?

optional unique: boolean

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

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