Module
x/discord_api_types/payloads/v6/channel.ts
Up to date Discord API Typings, versioned by the API version
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344/** * Types extracted from https://discord.com/developers/docs/resources/channel */
import type { APIPartialEmoji } from './emoji.ts';import type { APIGuildMember } from './guild.ts';import type { APIUser } from './user.ts';
/** * Not documented, but partial only includes id, name, and type * @deprecated API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8. */export interface APIPartialChannel { id: string; type: ChannelType; name?: string;}
/** * https://discord.com/developers/docs/resources/channel#channel-object-channel-structure * @deprecated API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8. */export interface APIChannel extends APIPartialChannel { guild_id?: string; position?: number; permission_overwrites?: APIOverwrite[]; name?: string; topic?: string | null; nsfw?: boolean; last_message_id?: string | null; bitrate?: number; user_limit?: number; rate_limit_per_user?: number; recipients?: APIUser[]; icon?: string | null; owner_id?: string; application_id?: string; parent_id?: string | null; last_pin_timestamp?: string | null;}
/** * https://discord.com/developers/docs/resources/channel#channel-object-channel-types * @deprecated API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8. */export enum ChannelType { GUILD_TEXT = 0, DM, GUILD_VOICE, GROUP_DM, GUILD_CATEGORY, GUILD_NEWS, GUILD_STORE,}
/** * https://discord.com/developers/docs/resources/channel#message-object-message-structure * @deprecated API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8. */export interface APIMessage { id: string; channel_id: string; guild_id?: string; author: APIUser; member?: APIGuildMember; content: string; timestamp: string; edited_timestamp: string | null; tts: boolean; mention_everyone: boolean; mentions: (APIUser & { member?: Omit<APIGuildMember, 'user'> })[]; mention_roles: string[]; mention_channels?: APIChannelMention[]; attachments: APIAttachment[]; embeds: APIEmbed[]; reactions?: APIReaction[]; nonce?: string | number; pinned: boolean; webhook_id?: string; type: MessageType; activity?: APIMessageActivity; application?: APIMessageApplication; message_reference?: APIMessageReference; flags?: MessageFlags; referenced_message?: APIMessage | null;}
/** * https://discord.com/developers/docs/resources/channel#message-object-message-types * @deprecated API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8. */export enum MessageType { DEFAULT, RECIPIENT_ADD, RECIPIENT_REMOVE, CALL, CHANNEL_NAME_CHANGE, CHANNEL_ICON_CHANGE, CHANNEL_PINNED_MESSAGE, GUILD_MEMBER_JOIN, USER_PREMIUM_GUILD_SUBSCRIPTION, USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_1, USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_2, USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_3, CHANNEL_FOLLOW_ADD, GUILD_DISCOVERY_DISQUALIFIED = 14, GUILD_DISCOVERY_REQUALIFIED, GUILD_DISCOVERY_GRACE_PERIOD_INITIAL_WARNING, GUILD_DISCOVERY_GRACE_PERIOD_FINAL_WARNING,}
/** * https://discord.com/developers/docs/resources/channel#message-object-message-activity-structure * @deprecated API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8. */export interface APIMessageActivity { type: MessageActivityType; party_id?: string;}
/** * https://discord.com/developers/docs/resources/channel#message-object-message-application-structure * @deprecated API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8. */export interface APIMessageApplication { id: string; cover_image?: string; description: string; icon: string | null; name: string;}
/** * https://discord.com/developers/docs/resources/channel#message-object-message-reference-structure * @deprecated API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8. */export interface APIMessageReference { message_id?: string; channel_id: string; guild_id?: string;}
/** * https://discord.com/developers/docs/resources/channel#message-object-message-activity-types * @deprecated API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8. */export enum MessageActivityType { JOIN = 1, SPECTATE, LISTEN, JOIN_REQUEST = 5,}
/** * https://discord.com/developers/docs/resources/channel#message-object-message-flags * @deprecated API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8. */export enum MessageFlags { CROSSPOSTED = 1 << 0, IS_CROSSPOST = 1 << 1, SUPPRESS_EMBEDS = 1 << 2, SOURCE_MESSAGE_DELETED = 1 << 3, URGENT = 1 << 4,}
/** * https://discord.com/developers/docs/resources/channel#reaction-object-reaction-structure * @deprecated API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8. */export interface APIReaction { count: number; me: boolean; emoji: APIPartialEmoji;}
/** * https://discord.com/developers/docs/resources/channel#overwrite-object-overwrite-structure * @deprecated API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8. */export interface APIOverwrite { id: string; type: OverwriteType; /** * @deprecated Use `allow_new` instead */ allow: number; allow_new: string; /** * @deprecated Use `deny_new` instead */ deny: number; deny_new: string;}
/** * @deprecated API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8. */export enum OverwriteType { Member = 'member', Role = 'role',}
/** * https://discord.com/developers/docs/resources/channel#embed-object-embed-structure * @deprecated API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8. */export interface APIEmbed { title?: string; /** * @deprecated *Embed types should be considered deprecated and might be removed in a future API version* */ type?: EmbedType; description?: string; url?: string; timestamp?: string; color?: number; footer?: APIEmbedFooter; image?: APIEmbedImage; thumbnail?: APIEmbedThumbnail; video?: APIEmbedVideo; provider?: APIEmbedProvider; author?: APIEmbedAuthor; fields?: APIEmbedField[];}
/** * https://discord.com/developers/docs/resources/channel#embed-object-embed-types * @deprecated *Embed types should be considered deprecated and might be removed in a future API version* * @deprecated API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8. */export enum EmbedType { Rich = 'rich', Image = 'image', Video = 'video', GifV = 'gifv', Article = 'article', Link = 'link',}
/** * https://discord.com/developers/docs/resources/channel#embed-object-embed-thumbnail-structure * @deprecated API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8. */export interface APIEmbedThumbnail { url?: string; proxy_url?: string; height?: number; width?: number;}
/** * https://discord.com/developers/docs/resources/channel#embed-object-embed-video-structure * @deprecated API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8. */export interface APIEmbedVideo { url?: string; height?: number; width?: number;}
/** * https://discord.com/developers/docs/resources/channel#embed-object-embed-image-structure * @deprecated API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8. */export interface APIEmbedImage { url?: string; proxy_url?: string; height?: number; width?: number;}
/** * https://discord.com/developers/docs/resources/channel#embed-object-embed-provider-structure * @deprecated API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8. */export interface APIEmbedProvider { name?: string; url?: string;}
/** * https://discord.com/developers/docs/resources/channel#embed-object-embed-author-structure * @deprecated API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8. */export interface APIEmbedAuthor { name?: string; url?: string; icon_url?: string; proxy_icon_url?: string;}
/** * https://discord.com/developers/docs/resources/channel#embed-object-embed-footer-structure * @deprecated API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8. */export interface APIEmbedFooter { text: string; icon_url?: string; proxy_icon_url?: string;}
/** * https://discord.com/developers/docs/resources/channel#embed-object-embed-field-structure * @deprecated API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8. */export interface APIEmbedField { name: string; value: string; inline?: boolean;}
/** * https://discord.com/developers/docs/resources/channel#attachment-object-attachment-structure * @deprecated API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8. */export interface APIAttachment { id: string; filename: string; size: number; url: string; proxy_url: string; height: number | null; width: number | null;}
/** * https://discord.com/developers/docs/resources/channel#channel-mention-object-channel-mention-structure * @deprecated API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8. */export interface APIChannelMention { id: string; guild_id: string; type: ChannelType; name: string;}
/** * @deprecated API and Gateway v6 are deprecated and the types will not receive further updates, please update to v8. */export interface APIFollowedChannel { channel_id: string; webhook_id: string;}