feat(Guild): add systemChannelFlags (#3559)

* Add systemChannelFlags bitfield to Guild

* Implement @vladfrangu's suggestions

* fix: apply suggestions, reverse order of flags, reword docs

* docs: add SystemCHannelFlagsResolvable typedef

Co-authored-by: SpaceEEC <spaceeec@yahoo.com>
This commit is contained in:
ottomated
2019-12-21 12:27:14 -08:00
committed by SpaceEEC
parent e13b3f550d
commit f578cce9ac
4 changed files with 68 additions and 0 deletions

13
typings/index.d.ts vendored
View File

@@ -714,6 +714,7 @@ declare module 'discord.js' {
public shardID: number;
public splash: string | null;
public readonly systemChannel: TextChannel | null;
public systemChannelFlags: Readonly<SystemChannelFlags>;
public systemChannelID: Snowflake | null;
public vanityURLCode: string | null;
public verificationLevel: number;
@@ -755,6 +756,7 @@ declare module 'discord.js' {
public setRolePositions(rolePositions: RolePosition[]): Promise<Guild>;
public setSplash(splash: Base64Resolvable | null, reason?: string): Promise<Guild>;
public setSystemChannel(systemChannel: ChannelResolvable | null, reason?: string): Promise<Guild>;
public setSystemChannelFlags(systemChannelFlags: SystemChannelFlagsResolvable, reason?: string): Promise<Guild>;
public setVerificationLevel(verificationLevel: number, reason?: string): Promise<Guild>;
public splashURL(options?: AvatarOptions): string | null;
public toJSON(): object;
@@ -1368,6 +1370,11 @@ declare module 'discord.js' {
static extend<T extends Function>(structure: string, extender: (baseClass: typeof Function) => T): T;
}
export class SystemChannelFlags extends BitField<SystemChannelFlagsString> {
public static FLAGS: Record<SystemChannelFlagsString, number>;
public static resolve(bit?: BitFieldResolvable<SystemChannelFlagsString>): number;
}
export class TextChannel extends TextBasedChannel(GuildChannel) {
constructor(guild: Guild, data?: object);
public messages: MessageStore;
@@ -2285,6 +2292,7 @@ declare module 'discord.js' {
defaultMessageNotifications?: DefaultMessageNotifications | number;
afkChannel?: ChannelResolvable;
systemChannel?: ChannelResolvable;
systemChannelFlags?: SystemChannelFlags;
afkTimeout?: number;
icon?: Base64Resolvable;
owner?: GuildMemberResolvable;
@@ -2613,6 +2621,11 @@ declare module 'discord.js' {
type StringResolvable = string | string[] | any;
type SystemChannelFlagsString = 'WELCOME_MESSAGE_DISABLED'
| 'BOOST_MESSAGE_DISABLED';
type SystemChannelFlagsResolvable = BitFieldResolvable<SystemChannelFlagsString>;
type TargetUser = number;
type UserResolvable = User | Snowflake | Message | GuildMember;