feat: deprecate GuildEmbed methods and properties in favour of GuildWidget (#4121)

This commit is contained in:
Sugden
2020-08-12 08:33:00 +01:00
committed by GitHub
parent baffbdb541
commit e92cbc444b
2 changed files with 74 additions and 13 deletions

21
typings/index.d.ts vendored
View File

@@ -674,7 +674,7 @@ declare module 'discord.js' {
public fetchAuditLogs(options?: GuildAuditLogsFetchOptions): Promise<GuildAuditLogs>;
public fetchBan(user: UserResolvable): Promise<{ user: User; reason: string }>;
public fetchBans(): Promise<Collection<Snowflake, { user: User; reason: string }>>;
public fetchEmbed(): Promise<GuildEmbedData>;
public fetchEmbed(): Promise<GuildWidget>;
public fetchIntegrations(): Promise<Collection<string, Integration>>;
public fetchInvites(): Promise<Collection<string, Invite>>;
public fetchPreview(): Promise<GuildPreview>;
@@ -682,6 +682,7 @@ declare module 'discord.js' {
public fetchVanityData(): Promise<{ code: string; uses: number }>;
public fetchVoiceRegions(): Promise<Collection<string, VoiceRegion>>;
public fetchWebhooks(): Promise<Collection<Snowflake, Webhook>>;
public fetchWidget(): Promise<GuildWidget>;
public iconURL(options?: ImageURLOptions & { dynamic?: boolean }): string | null;
public leave(): Promise<Guild>;
public member(user: UserResolvable): GuildMember | null;
@@ -693,7 +694,7 @@ declare module 'discord.js' {
defaultMessageNotifications: DefaultMessageNotifications | number,
reason?: string,
): Promise<Guild>;
public setEmbed(embed: GuildEmbedData, reason?: string): Promise<Guild>;
public setEmbed(embed: GuildWidgetData, reason?: string): Promise<Guild>;
public setExplicitContentFilter(explicitContentFilter: ExplicitContentFilterLevel, reason?: string): Promise<Guild>;
public setIcon(icon: Base64Resolvable | null, reason?: string): Promise<Guild>;
public setName(name: string, reason?: string): Promise<Guild>;
@@ -704,6 +705,7 @@ declare module 'discord.js' {
public setSystemChannel(systemChannel: ChannelResolvable | null, reason?: string): Promise<Guild>;
public setSystemChannelFlags(systemChannelFlags: SystemChannelFlagsResolvable, reason?: string): Promise<Guild>;
public setVerificationLevel(verificationLevel: VerificationLevel, reason?: string): Promise<Guild>;
public setWidget(widget: GuildWidgetData, reason?: string): Promise<Guild>;
public splashURL(options?: ImageURLOptions): string | null;
public toJSON(): object;
public toString(): string;
@@ -2519,6 +2521,11 @@ declare module 'discord.js' {
name?: string;
}
interface GuildWidget {
enabled: boolean;
channel: GuildChannel | null;
}
interface GuildEditData {
name?: string;
region?: string;
@@ -2535,11 +2542,6 @@ declare module 'discord.js' {
banner?: Base64Resolvable;
}
interface GuildEmbedData {
enabled: boolean;
channel: GuildChannelResolvable | null;
}
interface GuildEmojiCreateOptions {
roles?: Collection<Snowflake, Role> | RoleResolvable[];
reason?: string;
@@ -2585,6 +2587,11 @@ declare module 'discord.js' {
reason?: string;
}
interface GuildWidgetData {
enabled: boolean;
channel: GuildChannelResolvable | null;
}
interface HTTPOptions {
api?: string;
version?: number;