Preview environment

interface GuildScheduledEventInviteURLCreateOptions

export interface GuildScheduledEventInviteURLCreateOptions extends InviteCreateOptions

Options used to create an invite URL to a GuildScheduledEvent

optional
channel? : GuildInvitableChannelResolvable

The channel to create the invite in. This is required when the entityType of GuildScheduledEvent is GuildScheduledEventEntityType.External, gets ignored otherwise

optional
maxAge? : number

How long the invite should last (in seconds, 0 for forever)

Inherited from: InviteCreateOptions

optional
maxUses? : number

Maximum number of uses

Inherited from: InviteCreateOptions

optional
reason? : string

The reason for creating the invite

Inherited from: InviteCreateOptions

optional
targetApplication? : ApplicationResolvable

The embedded application to open for this invite, required if targetType is InviteTargetType.Stream, the application must have the InviteTargetType.EmbeddedApplication flag

Inherited from: InviteCreateOptions

optional
targetType? : InviteTargetType

The type of the target for this voice channel invite

Inherited from: InviteCreateOptions

optional
targetUser? : UserResolvable

The user whose stream to display for this invite, required if targetType is InviteTargetType.Stream, the user must be streaming in the channel

Inherited from: InviteCreateOptions

optional
temporary? : boolean

Whether members that joined via the invite should be automatically kicked after 24 hours if they have not yet received a role

Inherited from: InviteCreateOptions

optional
unique? : boolean

Create a unique invite, or use an existing one with similar settings

Inherited from: InviteCreateOptions