InviteFlagsBitField

bitfield

On this page

InviteFlagsBitField is a DiscordLua bitfield representing a Discord resource. Obtain it from a manager, an event payload, or the constructor when one is documented below.

bitfield Module 1.2.4 Source

Constructor

InviteFlagsBitField.new(bits)

The class table is callable, so InviteFlagsBitField(bits) is the same as .new.

Name	Type	Required	Behavior
`bits`	`any`	required	Passed through to the implementation as written.

lua

local discord = require("discord")
local object = discord.InviteFlagsBitField({})

Properties

InviteFlagsBitField.bitfield

# readonly

Name: bitfield
Type: any
Access: readonly
Description: Instance field InviteFlagsBitField.bitfield. Read it after the object is constructed or wrapped from Gateway/REST data.
Availability: Populated from the Gateway/REST payload or constructor for this InviteFlagsBitField.

InviteFlagsBitField.flags

# readonly

Name: flags
Type: any
Access: readonly
Description: Instance field InviteFlagsBitField.flags. Read it after the object is constructed or wrapped from Gateway/REST data.
Availability: Populated from the Gateway/REST payload or constructor for this InviteFlagsBitField.

Methods

InviteFlagsBitField.resolve()

# static

Resolve a snowflake, object, or mention to a cached instance.

Signature

InviteFlagsBitField.resolve(bits)

Parameters

Name	Type	Required	Behavior
`bits`	`any`	required	Passed through to the implementation as written.

Returns

InviteFlagsBitField — the same instance, for chaining.

Example

lua

local discord = require("discord")
-- object is a InviteFlagsBitField
InviteFlagsBitField.resolve(bits)

Static members

InviteFlagsBitField.Flags

Examples

lua

local discord = require("discord")
local object = discord.InviteFlagsBitField({})

ActivityFlagsBitField · ApplicationFlagsBitField · AttachmentFlagsBitField · BitField · ChannelFlagsBitField · GuildMemberFlagsBitField · IntentsBitField · MessageFlagsBitField

Version: discord 1.2.4 · runtime 1.0.0