Link Search Menu Expand Document (external link)
Documentation

Birb / SystemChannelFlags

Class: SystemChannelFlags

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new SystemChannelFlags(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/SystemChannelFlags.ts:24

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 = SystemChannelFlag

The possible Intents the client can use.

Type declaration

Name Type
SUPPRESS_GUILD_REMINDER_NOTIFICATIONS bigint
SUPPRESS_JOIN_NOTIFICATIONS bigint
SUPPRESS_JOIN_NOTIFICATION_REPLIES bigint
SUPPRESS_PREMIUM_SUBSCRIPTIONS bigint

Defined in

src/classes/bitfields/SystemChannelFlags.ts:17

Methods

add

▸ add(…flags): SystemChannelFlags

Adds bits to the Bitfield.

Parameters

Name Type Description
...flags BitResolvable<"SUPPRESS_JOIN_NOTIFICATIONS" | "SUPPRESS_PREMIUM_SUBSCRIPTIONS" | "SUPPRESS_GUILD_REMINDER_NOTIFICATIONS" | "SUPPRESS_JOIN_NOTIFICATION_REPLIES">[] The BitResolvable(s) to add.

Returns

SystemChannelFlags

The updated Bitfield instance.

Inherited from

Bitfield.add

Defined in

src/classes/bitfields/Bitfield.ts:79

clone

▸ clone(): SystemChannelFlags

Clones the Bitfield.

Returns

SystemChannelFlags

The cloned Bitfield.

Overrides

Bitfield.clone

Defined in

src/classes/bitfields/SystemChannelFlags.ts:28

convert

▸ convert(flags): bigint

Converts a BitResolvable to a bigint.

Parameters

Name Type Description
flags BitResolvable<"SUPPRESS_JOIN_NOTIFICATIONS" | "SUPPRESS_PREMIUM_SUBSCRIPTIONS" | "SUPPRESS_GUILD_REMINDER_NOTIFICATIONS" | "SUPPRESS_JOIN_NOTIFICATION_REPLIES"> | BitResolvable<"SUPPRESS_JOIN_NOTIFICATIONS" | "SUPPRESS_PREMIUM_SUBSCRIPTIONS" | "SUPPRESS_GUILD_REMINDER_NOTIFICATIONS" | "SUPPRESS_JOIN_NOTIFICATION_REPLIES">[] 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<"SUPPRESS_JOIN_NOTIFICATIONS" | "SUPPRESS_PREMIUM_SUBSCRIPTIONS" | "SUPPRESS_GUILD_REMINDER_NOTIFICATIONS" | "SUPPRESS_JOIN_NOTIFICATION_REPLIES">[] 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): SystemChannelFlags

Removes bits from the Bitfield.

Parameters

Name Type Description
...flags BitResolvable<"SUPPRESS_JOIN_NOTIFICATIONS" | "SUPPRESS_PREMIUM_SUBSCRIPTIONS" | "SUPPRESS_GUILD_REMINDER_NOTIFICATIONS" | "SUPPRESS_JOIN_NOTIFICATION_REPLIES">[] The BitResolvable(s) to remove.

Returns

SystemChannelFlags

The updated Bitfield instance.

Inherited from

Bitfield.remove

Defined in

src/classes/bitfields/Bitfield.ts:111

set

▸ set(…flags): SystemChannelFlags

Sets the contents of the Bitfield.

Parameters

Name Type Description
...flags BitResolvable<"SUPPRESS_JOIN_NOTIFICATIONS" | "SUPPRESS_PREMIUM_SUBSCRIPTIONS" | "SUPPRESS_GUILD_REMINDER_NOTIFICATIONS" | "SUPPRESS_JOIN_NOTIFICATION_REPLIES">[] The BitResolvable(s) to set.

Returns

SystemChannelFlags

The updated Bitfield instance.

Inherited from

Bitfield.set

Defined in

src/classes/bitfields/Bitfield.ts:95

toArray

▸ toArray(): ("SUPPRESS_JOIN_NOTIFICATIONS" | "SUPPRESS_PREMIUM_SUBSCRIPTIONS" | "SUPPRESS_GUILD_REMINDER_NOTIFICATIONS" | "SUPPRESS_JOIN_NOTIFICATION_REPLIES")[]

Converts the Bitfield to an array of strings.

Returns

("SUPPRESS_JOIN_NOTIFICATIONS" | "SUPPRESS_PREMIUM_SUBSCRIPTIONS" | "SUPPRESS_GUILD_REMINDER_NOTIFICATIONS" | "SUPPRESS_JOIN_NOTIFICATION_REPLIES")[]

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