mirror of
https://github.com/discordeno/discordeno.git
synced 2026-06-04 01:40:08 +00:00
1edb3c2110
* refactor(bot,helpers,plugins,rest,util)!: improve rest route handling - rename endpoints constant to routes - simplify routes code by removing bases and function calls - url query params can now be passed to the route functions * style: deno fmt * fix base stuff * suggestions
26 lines
1.2 KiB
TypeScript
26 lines
1.2 KiB
TypeScript
import type { Bot } from "../../bot.ts";
|
|
|
|
/** Returns the widget image URL for the guild. */
|
|
export async function getWidgetImageURL(bot: Bot, guildId: bigint, options?: GetGuildWidgetImageQuery) {
|
|
return bot.constants.routes.GUILD_WIDGET_IMAGE(guildId, options?.style);
|
|
}
|
|
|
|
/** https://discord.com/developers/docs/resources/guild#get-guild-widget-image-query-string-params */
|
|
export interface GetGuildWidgetImageQuery {
|
|
/**
|
|
* Style of the widget returned, default: shield
|
|
*
|
|
* Shield: Widget with Discord icon and guild members online count.
|
|
* Banner1: Large image with guild icon, name and online count. "POWERED BY DISCORD" as the footer of the widget
|
|
* Banner2: Smaller widget style with guild icon, name and online count. Split on the right with Discord logo
|
|
* Banner3: Large image with guild icon, name and online count. In the footer, Discord logo on the left and "Chat Now" on the right
|
|
* Banner4: Large Discord logo at the top of the widget. Guild icon, name and online count in the middle portion of the widget and a "JOIN MY SERVER" button at the bottom
|
|
*/
|
|
style?:
|
|
| "shield"
|
|
| "banner1"
|
|
| "banner2"
|
|
| "banner3"
|
|
| "banner4";
|
|
}
|