Invite

Implementation of discords Invite object as a Luau builder.

https://discord.com/developers/docs/resources/channel#create-channel-invite-json-params

Properties

The Invite instance has no set properties!

Methods

The Invite instance has no set methods!

Functions

setMaxAge

Invite . setMaxAge (

self: Invite
age: number
) -> ()

Sets the duration in seconds after which the invite expires. Age must be between 0 and 604800 seconds.

setMaxUses

Invite . setMaxUses (

self: Invite
uses: number
) -> ()

Sets the maximum number of times this invite can be used. Uses must be between 0 and 100.

setTemporary

Invite . setTemporary (

self: Invite
isTemporary: boolean
) -> ()

Sets whether the invite grants temporary membership. Temporary members are removed when they disconnect unless granted a role.

setIsUnique

Invite . setIsUnique (

self: Invite
isUnique: boolean
) -> ()

Sets whether this invite should be unique. If true, don’t try to reuse a similar invite.

setTargetType

Invite . setTargetType (

self: Invite
targetType: apiTypes.InviteTargetType
) -> ()

Sets the type of target for this invite. Used for stream and embedded application invites.

setTargetUser

Invite . setTargetUser (

self: Invite
userId: string
) -> ()

Sets the target user ID for this invite. Used to specify which user’s stream to display for stream invites.

setTargetApplication

Invite . setTargetApplication (

self: Invite
applicationId: string
) -> ()

Sets the target application ID for this invite. Used to specify which embedded application to open.

build

Invite . build (

self: Invite
) -> ()

Responsible for buillding the invite object that the Discord API can understand.

new

Invite . new (

     resource: {
       maxAge: number?,
       maxUses: number?,
       temporary: boolean?,
       unique: boolean?,
       targetType: apiTypes.InviteTargetType?,
       targetUserId: string?,
       targetApplicationId: string?,
    }
) -> ()

Responsible for creating a new Invite.