CreateInviteOptions

typedef · Source

Options used to create an invite to a guild channel. Type: Object

Properties

temporary

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

Default: false

maxAge

optional

maxAge: number

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

Default: 86400

maxUses

optional

maxUses: number

Maximum number of uses

Default: 0

unique

optional

unique: boolean

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

Default: false

targetUser

optional

targetUser: UserResolvable

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

targetApplication

optional

targetApplication: ApplicationResolvable

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

targetType

optional

targetType: TargetType

The type of the target for this voice channel invite

targetUsersFile

optional

targetUsersFile: TargetUsersFileResolvable

A CSV file or users allowed to accept the invite

roleIds

optional

roleIds: Array<RoleResolvable>

Roles assigned when the invite is accepted

reason

optional

reason: string

The reason for creating the invite