Results

Namespace

Type

Options used when creating an invite, typically with discord.GuildChannel.createInvite.

Hierarchy

  • ICreateVoiceChannelInviteOptions <-- You are here!

Index

Properties

Optional maxAge

maxAge: undefined | number

The lifetime of this invite, in seconds. 0 for never.

Default: 86400 (24 hours)

Optional maxUses

maxUses: undefined | number

The maximum number of times this invite can be used before deleting itself.

Default: 0 (unlimited)

Optional targetUser

targetUser: Snowflake

The target user id for this invite. The target user must be streaming video in a channel.

The invite created will resolved specifically to the broadcast rather than just the voice channel.

Optional targetUserType

targetUserType: TargetUserType

Specifies the type of invite and user this targets.

Right now, the only possible option is discord.Invite.TargetUserType.STREAM.

Optional temporary

temporary: undefined | false | true

If true, this invite will allow for temporary membership to the guild.

The user will be kicked from the guild if they go offline and haven't been given a role.

Default: false

Optional unique

unique: undefined | false | true

If true, the invite is guaranteed to be new and unique.

Otherwise, a recently created similar invite may be returned.

Default: false

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc