Link Search Menu Expand Document (external link)
Documentation

Birb / Intents

Class: Intents

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new Intents(bits?)

The Intents Bitfield stores bits as bigints.

Parameters

Name Type Description
bits? number | bigint The bigint or number representation of the Bitfield.

Overrides

Bitfield.constructor

Defined in

src/classes/bitfields/Intents.ts:38

Properties

bits

• bits: bigint

The bits as a bigint.

Inherited from

Bitfield.bits

Defined in

src/classes/bitfields/Bitfield.ts:10

FLAGS

▪ Static Readonly FLAGS: Object = IntentFlag

The possible Intents the client can use.

Type declaration

Name Type
AUTO_MODERATION_CONFIGURATION bigint
AUTO_MODERATION_EXECUTION bigint
DIRECT_MESSAGES bigint
DIRECT_MESSAGE_REACTIONS bigint
DIRECT_MESSAGE_TYPING bigint
GUILDS bigint
GUILD_BANS bigint
GUILD_EMOJIS_AND_STICKERS bigint
GUILD_INTEGRATIONS bigint
GUILD_INVITES bigint
GUILD_MEMBERS bigint
GUILD_MESSAGES bigint
GUILD_MESSAGE_REACTIONS bigint
GUILD_MESSAGE_TYPING bigint
GUILD_PRESENCES bigint
GUILD_SCHEDULED_EVENTS bigint
GUILD_VOICE_STATES bigint
GUILD_WEBHOOKS bigint
MESSAGE_CONTENT bigint

Defined in

src/classes/bitfields/Intents.ts:31

Methods

add

▸ add(…flags): Intents

Adds bits to the Bitfield.

Parameters

Name Type Description
...flags BitResolvable<"GUILDS" | "GUILD_MEMBERS" | "GUILD_BANS" | "GUILD_EMOJIS_AND_STICKERS" | "GUILD_INTEGRATIONS" | "GUILD_WEBHOOKS" | "GUILD_INVITES" | "GUILD_VOICE_STATES" | "GUILD_PRESENCES" | "GUILD_MESSAGES" | "GUILD_MESSAGE_REACTIONS" | "GUILD_MESSAGE_TYPING" | "DIRECT_MESSAGES" | "DIRECT_MESSAGE_REACTIONS" | "DIRECT_MESSAGE_TYPING" | "MESSAGE_CONTENT" | "GUILD_SCHEDULED_EVENTS" | "AUTO_MODERATION_CONFIGURATION" | "AUTO_MODERATION_EXECUTION">[] The BitResolvable(s) to add.

Returns

Intents

The updated Bitfield instance.

Inherited from

Bitfield.add

Defined in

src/classes/bitfields/Bitfield.ts:79

clone

▸ clone(): Intents

Clones the Bitfield.

Returns

Intents

The cloned Bitfield.

Overrides

Bitfield.clone

Defined in

src/classes/bitfields/Intents.ts:42

convert

▸ convert(flags): bigint

Converts a BitResolvable to a bigint.

Parameters

Name Type Description
flags BitResolvable<"GUILDS" | "GUILD_MEMBERS" | "GUILD_BANS" | "GUILD_EMOJIS_AND_STICKERS" | "GUILD_INTEGRATIONS" | "GUILD_WEBHOOKS" | "GUILD_INVITES" | "GUILD_VOICE_STATES" | "GUILD_PRESENCES" | "GUILD_MESSAGES" | "GUILD_MESSAGE_REACTIONS" | "GUILD_MESSAGE_TYPING" | "DIRECT_MESSAGES" | "DIRECT_MESSAGE_REACTIONS" | "DIRECT_MESSAGE_TYPING" | "MESSAGE_CONTENT" | "GUILD_SCHEDULED_EVENTS" | "AUTO_MODERATION_CONFIGURATION" | "AUTO_MODERATION_EXECUTION"> | BitResolvable<"GUILDS" | "GUILD_MEMBERS" | "GUILD_BANS" | "GUILD_EMOJIS_AND_STICKERS" | "GUILD_INTEGRATIONS" | "GUILD_WEBHOOKS" | "GUILD_INVITES" | "GUILD_VOICE_STATES" | "GUILD_PRESENCES" | "GUILD_MESSAGES" | "GUILD_MESSAGE_REACTIONS" | "GUILD_MESSAGE_TYPING" | "DIRECT_MESSAGES" | "DIRECT_MESSAGE_REACTIONS" | "DIRECT_MESSAGE_TYPING" | "MESSAGE_CONTENT" | "GUILD_SCHEDULED_EVENTS" | "AUTO_MODERATION_CONFIGURATION" | "AUTO_MODERATION_EXECUTION">[] The BitResolvable(s) to convert.

Returns

bigint

The bigint representation of the BitResolvable(s).

Inherited from

Bitfield.convert

Defined in

src/classes/bitfields/Bitfield.ts:43

has

▸ has(…flags): boolean

Checks if the Bitfield has the given flag.

Parameters

Name Type Description
...flags BitResolvable<"GUILDS" | "GUILD_MEMBERS" | "GUILD_BANS" | "GUILD_EMOJIS_AND_STICKERS" | "GUILD_INTEGRATIONS" | "GUILD_WEBHOOKS" | "GUILD_INVITES" | "GUILD_VOICE_STATES" | "GUILD_PRESENCES" | "GUILD_MESSAGES" | "GUILD_MESSAGE_REACTIONS" | "GUILD_MESSAGE_TYPING" | "DIRECT_MESSAGES" | "DIRECT_MESSAGE_REACTIONS" | "DIRECT_MESSAGE_TYPING" | "MESSAGE_CONTENT" | "GUILD_SCHEDULED_EVENTS" | "AUTO_MODERATION_CONFIGURATION" | "AUTO_MODERATION_EXECUTION">[] The BitResolvable(s) to check.

Returns

boolean

Whether the Bitfield has the given flag(s).

Inherited from

Bitfield.has

Defined in

src/classes/bitfields/Bitfield.ts:127

isEmpty

▸ isEmpty(): boolean

Checks if the Bitfield is empty.

Returns

boolean

Whether the Bitfield is empty.

Inherited from

Bitfield.isEmpty

Defined in

src/classes/bitfields/Bitfield.ts:136

isLocked

▸ isLocked(): boolean

Check if the Bitfield is locked.

Returns

boolean

Inherited from

Bitfield.isLocked

Defined in

src/classes/bitfields/Bitfield.ts:178

remove

▸ remove(…flags): Intents

Removes bits from the Bitfield.

Parameters

Name Type Description
...flags BitResolvable<"GUILDS" | "GUILD_MEMBERS" | "GUILD_BANS" | "GUILD_EMOJIS_AND_STICKERS" | "GUILD_INTEGRATIONS" | "GUILD_WEBHOOKS" | "GUILD_INVITES" | "GUILD_VOICE_STATES" | "GUILD_PRESENCES" | "GUILD_MESSAGES" | "GUILD_MESSAGE_REACTIONS" | "GUILD_MESSAGE_TYPING" | "DIRECT_MESSAGES" | "DIRECT_MESSAGE_REACTIONS" | "DIRECT_MESSAGE_TYPING" | "MESSAGE_CONTENT" | "GUILD_SCHEDULED_EVENTS" | "AUTO_MODERATION_CONFIGURATION" | "AUTO_MODERATION_EXECUTION">[] The BitResolvable(s) to remove.

Returns

Intents

The updated Bitfield instance.

Inherited from

Bitfield.remove

Defined in

src/classes/bitfields/Bitfield.ts:111

set

▸ set(…flags): Intents

Sets the contents of the Bitfield.

Parameters

Name Type Description
...flags BitResolvable<"GUILDS" | "GUILD_MEMBERS" | "GUILD_BANS" | "GUILD_EMOJIS_AND_STICKERS" | "GUILD_INTEGRATIONS" | "GUILD_WEBHOOKS" | "GUILD_INVITES" | "GUILD_VOICE_STATES" | "GUILD_PRESENCES" | "GUILD_MESSAGES" | "GUILD_MESSAGE_REACTIONS" | "GUILD_MESSAGE_TYPING" | "DIRECT_MESSAGES" | "DIRECT_MESSAGE_REACTIONS" | "DIRECT_MESSAGE_TYPING" | "MESSAGE_CONTENT" | "GUILD_SCHEDULED_EVENTS" | "AUTO_MODERATION_CONFIGURATION" | "AUTO_MODERATION_EXECUTION">[] The BitResolvable(s) to set.

Returns

Intents

The updated Bitfield instance.

Inherited from

Bitfield.set

Defined in

src/classes/bitfields/Bitfield.ts:95

toArray

▸ toArray(): ("GUILDS" | "GUILD_MEMBERS" | "GUILD_BANS" | "GUILD_EMOJIS_AND_STICKERS" | "GUILD_INTEGRATIONS" | "GUILD_WEBHOOKS" | "GUILD_INVITES" | "GUILD_VOICE_STATES" | "GUILD_PRESENCES" | "GUILD_MESSAGES" | "GUILD_MESSAGE_REACTIONS" | "GUILD_MESSAGE_TYPING" | "DIRECT_MESSAGES" | "DIRECT_MESSAGE_REACTIONS" | "DIRECT_MESSAGE_TYPING" | "MESSAGE_CONTENT" | "GUILD_SCHEDULED_EVENTS" | "AUTO_MODERATION_CONFIGURATION" | "AUTO_MODERATION_EXECUTION")[]

Converts the Bitfield to an array of strings.

Returns

("GUILDS" | "GUILD_MEMBERS" | "GUILD_BANS" | "GUILD_EMOJIS_AND_STICKERS" | "GUILD_INTEGRATIONS" | "GUILD_WEBHOOKS" | "GUILD_INVITES" | "GUILD_VOICE_STATES" | "GUILD_PRESENCES" | "GUILD_MESSAGES" | "GUILD_MESSAGE_REACTIONS" | "GUILD_MESSAGE_TYPING" | "DIRECT_MESSAGES" | "DIRECT_MESSAGE_REACTIONS" | "DIRECT_MESSAGE_TYPING" | "MESSAGE_CONTENT" | "GUILD_SCHEDULED_EVENTS" | "AUTO_MODERATION_CONFIGURATION" | "AUTO_MODERATION_EXECUTION")[]

The array of strings representation of the Bitfield.

Inherited from

Bitfield.toArray

Defined in

src/classes/bitfields/Bitfield.ts:154

toBigInt

▸ toBigInt(): bigint

Converts the Bitfield to a bigint.

Returns

bigint

The bigint representation of the Bitfield.

Inherited from

Bitfield.toBigInt

Defined in

src/classes/bitfields/Bitfield.ts:145