discord-api-types
Version:
Discord API typings that are kept up to date for use in bot library creation.
253 lines • 10.6 kB
JavaScript
"use strict";
/**
* Types extracted from https://discord.com/developers/docs/resources/channel
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.TextInputStyle = exports.ButtonStyle = exports.ComponentType = exports.AllowedMentionsTypes = exports.EmbedType = exports.OverwriteType = exports.MessageFlags = exports.MessageActivityType = exports.MessageType = exports.VideoQualityMode = exports.ChannelType = void 0;
/**
* https://discord.com/developers/docs/resources/channel#channel-object-channel-types
*
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
*/
var ChannelType;
(function (ChannelType) {
/**
* A text channel within a guild
*/
ChannelType[ChannelType["GuildText"] = 0] = "GuildText";
/**
* A direct message between users
*/
ChannelType[ChannelType["DM"] = 1] = "DM";
/**
* A voice channel within a guild
*/
ChannelType[ChannelType["GuildVoice"] = 2] = "GuildVoice";
/**
* A direct message between multiple users
*/
ChannelType[ChannelType["GroupDM"] = 3] = "GroupDM";
/**
* An organizational category that contains up to 50 channels
*
* See https://support.discord.com/hc/en-us/articles/115001580171-Channel-Categories-101
*/
ChannelType[ChannelType["GuildCategory"] = 4] = "GuildCategory";
/**
* A channel that users can follow and crosspost into their own guild
*
* See https://support.discord.com/hc/en-us/articles/360032008192
*/
ChannelType[ChannelType["GuildNews"] = 5] = "GuildNews";
/**
* A channel in which game developers can sell their game on Discord
*
* See https://discord.com/developers/docs/game-and-server-management/special-channels
*/
ChannelType[ChannelType["GuildStore"] = 6] = "GuildStore";
/**
* A voice channel for hosting events with an audience
*
* See https://support.discord.com/hc/en-us/articles/1500005513722
*/
ChannelType[ChannelType["GuildStageVoice"] = 13] = "GuildStageVoice";
})(ChannelType || (exports.ChannelType = ChannelType = {}));
/**
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
*/
var VideoQualityMode;
(function (VideoQualityMode) {
/**
* Discord chooses the quality for optimal performance
*/
VideoQualityMode[VideoQualityMode["Auto"] = 1] = "Auto";
/**
* 720p
*/
VideoQualityMode[VideoQualityMode["Full"] = 2] = "Full";
})(VideoQualityMode || (exports.VideoQualityMode = VideoQualityMode = {}));
/**
* https://discord.com/developers/docs/resources/channel#message-object-message-types
*
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
*/
var MessageType;
(function (MessageType) {
MessageType[MessageType["Default"] = 0] = "Default";
MessageType[MessageType["RecipientAdd"] = 1] = "RecipientAdd";
MessageType[MessageType["RecipientRemove"] = 2] = "RecipientRemove";
MessageType[MessageType["Call"] = 3] = "Call";
MessageType[MessageType["ChannelNameChange"] = 4] = "ChannelNameChange";
MessageType[MessageType["ChannelIconChange"] = 5] = "ChannelIconChange";
MessageType[MessageType["ChannelPinnedMessage"] = 6] = "ChannelPinnedMessage";
MessageType[MessageType["GuildMemberJoin"] = 7] = "GuildMemberJoin";
MessageType[MessageType["UserPremiumGuildSubscription"] = 8] = "UserPremiumGuildSubscription";
MessageType[MessageType["UserPremiumGuildSubscriptionTier1"] = 9] = "UserPremiumGuildSubscriptionTier1";
MessageType[MessageType["UserPremiumGuildSubscriptionTier2"] = 10] = "UserPremiumGuildSubscriptionTier2";
MessageType[MessageType["UserPremiumGuildSubscriptionTier3"] = 11] = "UserPremiumGuildSubscriptionTier3";
MessageType[MessageType["ChannelFollowAdd"] = 12] = "ChannelFollowAdd";
MessageType[MessageType["GuildDiscoveryDisqualified"] = 14] = "GuildDiscoveryDisqualified";
MessageType[MessageType["GuildDiscoveryRequalified"] = 15] = "GuildDiscoveryRequalified";
MessageType[MessageType["GuildDiscoveryGracePeriodInitialWarning"] = 16] = "GuildDiscoveryGracePeriodInitialWarning";
MessageType[MessageType["GuildDiscoveryGracePeriodFinalWarning"] = 17] = "GuildDiscoveryGracePeriodFinalWarning";
MessageType[MessageType["Reply"] = 19] = "Reply";
MessageType[MessageType["ChatInputCommand"] = 20] = "ChatInputCommand";
MessageType[MessageType["GuildInviteReminder"] = 22] = "GuildInviteReminder";
MessageType[MessageType["ContextMenuCommand"] = 23] = "ContextMenuCommand";
})(MessageType || (exports.MessageType = MessageType = {}));
/**
* https://discord.com/developers/docs/resources/channel#message-object-message-activity-types
*
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
*/
var MessageActivityType;
(function (MessageActivityType) {
MessageActivityType[MessageActivityType["Join"] = 1] = "Join";
MessageActivityType[MessageActivityType["Spectate"] = 2] = "Spectate";
MessageActivityType[MessageActivityType["Listen"] = 3] = "Listen";
MessageActivityType[MessageActivityType["JoinRequest"] = 5] = "JoinRequest";
})(MessageActivityType || (exports.MessageActivityType = MessageActivityType = {}));
/**
* https://discord.com/developers/docs/resources/channel#message-object-message-flags
*
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
*/
var MessageFlags;
(function (MessageFlags) {
/**
* This message has been published to subscribed channels (via Channel Following)
*/
MessageFlags[MessageFlags["Crossposted"] = 1] = "Crossposted";
/**
* This message originated from a message in another channel (via Channel Following)
*/
MessageFlags[MessageFlags["IsCrosspost"] = 2] = "IsCrosspost";
/**
* Do not include any embeds when serializing this message
*/
MessageFlags[MessageFlags["SuppressEmbeds"] = 4] = "SuppressEmbeds";
/**
* The source message for this crosspost has been deleted (via Channel Following)
*/
MessageFlags[MessageFlags["SourceMessageDeleted"] = 8] = "SourceMessageDeleted";
/**
* This message came from the urgent message system
*/
MessageFlags[MessageFlags["Urgent"] = 16] = "Urgent";
/**
* This message is only visible to the user who invoked the Interaction
*/
MessageFlags[MessageFlags["Ephemeral"] = 64] = "Ephemeral";
/**
* This message is an Interaction Response and the bot is "thinking"
*/
MessageFlags[MessageFlags["Loading"] = 128] = "Loading";
})(MessageFlags || (exports.MessageFlags = MessageFlags = {}));
/**
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
*/
var OverwriteType;
(function (OverwriteType) {
OverwriteType[OverwriteType["Role"] = 0] = "Role";
OverwriteType[OverwriteType["Member"] = 1] = "Member";
})(OverwriteType || (exports.OverwriteType = OverwriteType = {}));
/**
* https://discord.com/developers/docs/resources/channel#embed-object-embed-types
*
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
*/
var EmbedType;
(function (EmbedType) {
/**
* Generic embed rendered from embed attributes
*/
EmbedType["Rich"] = "rich";
/**
* Image embed
*/
EmbedType["Image"] = "image";
/**
* Video embed
*/
EmbedType["Video"] = "video";
/**
* Animated gif image embed rendered as a video embed
*/
EmbedType["GIFV"] = "gifv";
/**
* Article embed
*/
EmbedType["Article"] = "article";
/**
* Link embed
*/
EmbedType["Link"] = "link";
})(EmbedType || (exports.EmbedType = EmbedType = {}));
/**
* https://discord.com/developers/docs/resources/channel#allowed-mentions-object-allowed-mention-types
*
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
*/
var AllowedMentionsTypes;
(function (AllowedMentionsTypes) {
/**
* Controls @everyone and @here mentions
*/
AllowedMentionsTypes["Everyone"] = "everyone";
/**
* Controls role mentions
*/
AllowedMentionsTypes["Role"] = "roles";
/**
* Controls user mentions
*/
AllowedMentionsTypes["User"] = "users";
})(AllowedMentionsTypes || (exports.AllowedMentionsTypes = AllowedMentionsTypes = {}));
/**
* https://discord.com/developers/docs/interactions/message-components#component-types
*
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
*/
var ComponentType;
(function (ComponentType) {
/**
* Action Row component
*/
ComponentType[ComponentType["ActionRow"] = 1] = "ActionRow";
/**
* Button component
*/
ComponentType[ComponentType["Button"] = 2] = "Button";
/**
* Select Menu component
*/
ComponentType[ComponentType["SelectMenu"] = 3] = "SelectMenu";
/**
* Text Input component
*/
ComponentType[ComponentType["TextInput"] = 4] = "TextInput";
})(ComponentType || (exports.ComponentType = ComponentType = {}));
/**
* https://discord.com/developers/docs/interactions/message-components#button-object-button-styles
*
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
*/
var ButtonStyle;
(function (ButtonStyle) {
ButtonStyle[ButtonStyle["Primary"] = 1] = "Primary";
ButtonStyle[ButtonStyle["Secondary"] = 2] = "Secondary";
ButtonStyle[ButtonStyle["Success"] = 3] = "Success";
ButtonStyle[ButtonStyle["Danger"] = 4] = "Danger";
ButtonStyle[ButtonStyle["Link"] = 5] = "Link";
})(ButtonStyle || (exports.ButtonStyle = ButtonStyle = {}));
/**
* https://discord.com/developers/docs/interactions/message-components#text-inputs-text-input-styles
*
* @deprecated API and gateway v8 are deprecated and the types will not receive further updates, please update to v10.
*/
var TextInputStyle;
(function (TextInputStyle) {
TextInputStyle[TextInputStyle["Short"] = 1] = "Short";
TextInputStyle[TextInputStyle["Paragraph"] = 2] = "Paragraph";
})(TextInputStyle || (exports.TextInputStyle = TextInputStyle = {}));
//# sourceMappingURL=channel.js.map