SystemChannelFlags.js (1181B)
1 'use strict'; 2 3 const BitField = require('./BitField'); 4 5 /** 6 * Data structure that makes it easy to interact with a {@link Guild#systemChannelFlags} bitfield. 7 * <info>Note that all event message types are enabled by default, 8 * and by setting their corresponding flags you are disabling them</info> 9 * @extends {BitField} 10 */ 11 class SystemChannelFlags extends BitField {} 12 13 /** 14 * @name SystemChannelFlags 15 * @kind constructor 16 * @memberof SystemChannelFlags 17 * @param {SystemChannelFlagsResolvable} [bits=0] Bit(s) to read from 18 */ 19 20 /** 21 * Data that can be resolved to give a sytem channel flag bitfield. This can be: 22 * * A string (see {@link SystemChannelFlags.FLAGS}) 23 * * A sytem channel flag 24 * * An instance of SystemChannelFlags 25 * * An Array of SystemChannelFlagsResolvable 26 * @typedef {string|number|SystemChannelFlags|SystemChannelFlagsResolvable[]} SystemChannelFlagsResolvable 27 */ 28 29 /** 30 * Numeric system channel flags. All available properties: 31 * * `WELCOME_MESSAGE_DISABLED` 32 * * `BOOST_MESSAGE_DISABLED` 33 * @type {Object} 34 */ 35 SystemChannelFlags.FLAGS = { 36 WELCOME_MESSAGE_DISABLED: 1 << 0, 37 BOOST_MESSAGE_DISABLED: 1 << 1, 38 }; 39 40 module.exports = SystemChannelFlags;