Interface CreateInviteOptions

interface CreateInviteOptions {
    maxAge?: number;
    maxUses?: number;
    reason?: string;
    roleIDs?: string[];
    targetApplicationID?: string;
    targetType?: InviteTargetTypes;
    targetUserID?: string;
    targetUsers?: string[];
    temporary?: boolean;
    unique?: boolean;
}

Properties

maxAge? maxUses? reason? roleIDs? targetApplicationID? targetType? targetUserID? targetUsers? temporary? unique?

Properties

Optional maxAge

maxAge?: number

How long the invite should last.

Optional maxUses

maxUses?: number

How many times the invite can be used.

Optional reason

reason?: string

The reason for creating the invite.

Optional roleIDs

roleIDs?: string[]

The IDs of roles to add to the users using the invite. Requires the MANAGE_ROLES permission.

Optional targetApplicationID

targetApplicationID?: string

The id of the embedded application to open for this invite.

Optional targetType

targetType?: InviteTargetTypes

The type of target for the invite.

Optional targetUserID

targetUserID?: string

The ID of the user whose stream to display for this invite.

Optional targetUsers

targetUsers?: string[]

The IDs of users able to accept this invite.

Optional temporary

temporary?: boolean

If the invite should be temporary.

Optional unique

unique?: boolean

If the invite should be unique.

Settings

Member Visibility

Theme

On This Page

maxAgemaxUsesreasonroleIDstargetApplicationIDtargetTypetargetUserIDtargetUserstemporaryunique