52 lines
1.7 KiB
JavaScript
52 lines
1.7 KiB
JavaScript
'use strict';
|
|
|
|
const BitField = require('./BitField');
|
|
|
|
/**
|
|
* Data structure that makes it easy to interact with a {@link Guild#systemChannelFlags} bitfield.
|
|
* <info>Note that all event message types are enabled by default,
|
|
* and by setting their corresponding flags you are disabling them</info>
|
|
* @extends {BitField}
|
|
*/
|
|
class SystemChannelFlags extends BitField {}
|
|
|
|
/**
|
|
* @name SystemChannelFlags
|
|
* @kind constructor
|
|
* @memberof SystemChannelFlags
|
|
* @param {SystemChannelFlagsResolvable} [bits=0] Bit(s) to read from
|
|
*/
|
|
|
|
/**
|
|
* Bitfield of the packed bits
|
|
* @type {number}
|
|
* @name SystemChannelFlags#bitfield
|
|
*/
|
|
|
|
/**
|
|
* Data that can be resolved to give a system channel flag bitfield. This can be:
|
|
* * A string (see {@link SystemChannelFlags.FLAGS})
|
|
* * A system channel flag
|
|
* * An instance of SystemChannelFlags
|
|
* * An Array of SystemChannelFlagsResolvable
|
|
* @typedef {string|number|SystemChannelFlags|SystemChannelFlagsResolvable[]} SystemChannelFlagsResolvable
|
|
*/
|
|
|
|
/**
|
|
* Numeric system channel flags. All available properties:
|
|
* * `SUPPRESS_JOIN_NOTIFICATIONS` (Suppress member join notifications)
|
|
* * `SUPPRESS_PREMIUM_SUBSCRIPTIONS` (Suppress server boost notifications)
|
|
* * `SUPPRESS_GUILD_REMINDER_NOTIFICATIONS` (Suppress server setup tips)
|
|
* * `SUPPRESS_JOIN_NOTIFICATION_REPLIES` (Hide member join sticker reply buttons)
|
|
* @type {Object}
|
|
* @see {@link https://discord.com/developers/docs/resources/guild#guild-object-system-channel-flags}
|
|
*/
|
|
SystemChannelFlags.FLAGS = {
|
|
SUPPRESS_JOIN_NOTIFICATIONS: 1 << 0,
|
|
SUPPRESS_PREMIUM_SUBSCRIPTIONS: 1 << 1,
|
|
SUPPRESS_GUILD_REMINDER_NOTIFICATIONS: 1 << 2,
|
|
SUPPRESS_JOIN_NOTIFICATION_REPLIES: 1 << 3,
|
|
};
|
|
|
|
module.exports = SystemChannelFlags;
|