ChannelFlagsBitField

bitfield

On this page

ChannelFlagsBitField 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

ChannelFlagsBitField.new(bits)

The class table is callable, so ChannelFlagsBitField(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.ChannelFlagsBitField({})

Properties

ChannelFlagsBitField.bitfield

# readonly

Name: bitfield
Type: any
Access: readonly
Description: Instance field ChannelFlagsBitField.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 ChannelFlagsBitField.

ChannelFlagsBitField.flags

# readonly

Name: flags
Type: any
Access: readonly
Description: Instance field ChannelFlagsBitField.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 ChannelFlagsBitField.

Methods

ChannelFlagsBitField.resolve()

# static

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

Signature

ChannelFlagsBitField.resolve(bits)

Parameters

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

Returns

ChannelFlagsBitField — the same instance, for chaining.

Example

lua

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

Static members

ChannelFlagsBitField.Flags

Examples

lua

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

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

Version: discord 1.2.4 · runtime 1.0.0