Skip to main content
Module

x/biscuit/mod.ts>DiscordInviteOptions

A Discord library that is easy to use but reliable on its core 🥠
oasisjs/biscuit
Latest
interface DiscordInviteOptions
import { type DiscordInviteOptions } from "https://deno.land/x/biscuit@0.2.4/mod.ts";

Properties

optional
maxAge: number

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

optional
maxUses: number

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

optional
unique: boolean

if the invitation is unique. If it's true, don't try to reuse a similar invite (useful for creating many unique one time use invites)

temporary: boolean

whether this invite only grants temporary membership

optional
reason: string
optional
targetType: TargetTypes

the type of target for this voice channel invite

optional
targetUserId: Snowflake

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

optional
targetApplicationId: Snowflake

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