Interface ICreateInviteFields

interface ICreateInviteFields {
    maxAgeSeconds?: number;
    maxUses?: number;
    targetApplicationId?: string;
    targetType?: InviteTargetType;
    targetUserId?: string;
    temporary?: boolean;
    unique?: boolean;
}

Properties

maxAgeSeconds? maxUses? targetApplicationId? targetType? targetUserId? temporary? unique?

Properties

Optional maxAgeSeconds

maxAgeSeconds?: number

Duration of invite in seconds before expiry, or 0 for never. between 0 and 604800 (7 days)

Default: 24 hours

Optional maxUses

maxUses?: number

Max number of uses or 0 for unlimited. between 0 and 100

Default: 0 (unlimited)

Optional targetApplicationId

targetApplicationId?: string

The id of the embedded application to open for this invite, required if targetType is 'EmbeddedApplication', the application must have the EMBEDDED flag

Optional targetType

targetType?: InviteTargetType

The type of target for this voice channel invite

Optional targetUserId

targetUserId?: string

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

Optional temporary

temporary?: boolean

Whether this invite only grants temporary membership

Default: false

Optional unique

unique?: boolean

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

Default false

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc