Pular para o conteúdo
Documentação DiscordKit

Mapa da API no cookbook

Cobertura, variantes e limites da API usada no projeto.

Abrir texto

Este mapa organiza a API pública por famílias. Uso no bot, experimento e variante explicada não são a mesma coisa. O caminho principal implementa o atendimento; o laboratório demonstra recursos complementares; variantes cosméticas ou dependentes de monetização são explicadas sem simular funcionalidades que não existem.

API Capítulo e aplicação
Command, Options, Build, MustBuild, BuildCommands Definições e validação; MustBuild panica em caso de erro.
SubCommand, SubCommandGroup Ticket agrupa ações; lab options inspect mostra o segundo nível.
UserCommand, MessageCommand Menus de contexto; alvo em TargetID/resolved do discordgo.
NameLocalizations, DescriptionLocalizations, Choice.Localized Lab localiza o nome. Descrições e escolhas seguem mapas Locale; o caminho do router permanece canônico.
DefaultMemberPermissions, Contexts, IntegrationTypes, NSFW Permissão padrão de panel é usada. Contexts/IntegrationTypes são configurações de distribuição (sobretudo global); NSFW não é necessário neste bot. Não copie indiscriminadamente para sync em guild.
StringOption, IntegerOption, NumberOption, BooleanOption ID, nota, peso e visibilidade; Required, limites, Choices ou Autocomplete.
UserOption, RoleOption, ChannelOption, MentionableOption, AttachmentOption Objetos resolvidos; ChannelTypes limita a seleção.
Choice, Choices, Autocomplete Status fixos e busca dinâmica; escolhas e autocomplete são mutuamente exclusivos na mesma opção.
NewRouter, Use, Group, Command, Component, Modal, Autocomplete Registro por feature. Use acrescenta middleware global; Group compartilha prefixo e middleware.
Handle, Dispatch, NewContext Handle adapta o Gateway; Dispatch/NewContext permitem testar com eventos e transporte falso.
OnError, Handler, Middleware, Recovery, Logging, PanicError Erros e composição; Recovery é automático no Router. Stack de PanicError pertence ao log protegido, nunca à resposta pública.
RequireGuild, RequirePermissions Servidor e permissão do membro; não verificam permissões do bot no canal.
Context, SetContext, Session, Interaction Prazo REST e escape hatches nativos; não misture respostas raw e gerenciadas na mesma interação.
User, Member, GuildID, ChannelID, Locale, IsGuild, IsDM Metadados do evento. Este bot recusa DM e qualquer guild fora da configuração.
Option, FocusedOption, String, Int, Float, Bool Presença de opção é separada do valor zero; FocusedOption identifica a busca em edição.
UserOption, MemberOption, Role, Channel, Attachment, Mentionable Getters do Context leem resolved; Mentionable.Valid exige exatamente usuário ou cargo.
Require… e Must… / Require… and Must… Require retorna erro; Must panica. Use Require em entradas externas. Há variantes para string, int, float, bool, entidades e parâmetros.
CustomID.Validate, Route, Param, Build, MustBuild IDs estáveis, codificação de parâmetros e limite de 100 caracteres; não representam autorização.
Context.Param, RequireParam, MustParam Leitura do parâmetro decodificado pelo roteador.
MessageSpec, InteractionResponseData, WebhookParams, WebhookEdit, MessageEdit Um payload, conversões para cada endpoint; File/Attachments/AllowedMentions são campos explícitos.
Reply, ReplyText, Ephemeral, EphemeralText Primeira resposta e visibilidade; texto é conveniência sobre MessageSpec.
Defer, Edit, DeferUpdate, Update Defer antes do disco; Update para navegação imediata; Edit depois do reconhecimento.
Followup, FollowupEdit, DeleteResponse Exportação adicional, revisão da mensagem e ocultação pelo botão.
Context.Autocomplete, ShowModal Respostas iniciais específicas; não vêm depois de um defer de mensagem.
Components, Raw, Text, Row, Container, Separator Árvore V2; Container.AccentColor, Spoiler, Separator.Divider/Large alteram apresentação.
Button, LinkButton, PremiumButton Ações roteadas e links no bot. PremiumButton exige SKU real/monetização; não tem custom ID nem handler de compra fictício.
Primary, Secondary, Success, Danger, Emoji, Disabled Variantes de botão: estilo não concede permissão. Disabled evita cliques normais, mas o servidor revalida o estado.
SelectOption, StringSelect Opções, Description, Emoji, Default e Placeholder; valide values no handler.
UserSelect, RoleSelect, MentionableSelect, ChannelSelect Seleção de entidades, limites, DefaultValues e ChannelTypes; o laboratório demonstra três e propõe a variante mentionable.
Section, Thumbnail, Gallery, MediaItem, File Mídia V2, descrições, spoiler e attachment://; seção exige acessório.
Form, Fields, Field, TextInput, Modal, ModalOf Builder e conversão raw de modal; Value/Placeholder/Paragraph/Required/MinLen/MaxLen configuram inputs.
FileUpload, FileTypes, MinValues, MaxValues, Required Upload no formulário. FileTypes limita a interface; validar tipo/tamanho no servidor seria necessário antes de processar um arquivo.
Context.Form, FormData.String, Strings, Files, RequireString, MustString, RequireStrings, RequireFiles Texto e valores resolvidos do envio do modal; métodos Require detectam ausência.
ValidateMessageComponents, ValidateModalComponents Validação local, também executada pelos builders/conversores. Não substitui a validação remota.
SyncCommands, SyncOptions, DiffCommands, SyncPlan.Empty Sync sem exclusão por padrão; prévia via lista remota + DiffCommands. A opção real de remoção se chama Delete.

Use errors.Is com os sentinelas de errors.go para classificar erros, e errors.As para PanicError. Não compare o texto de uma mensagem. ErrAlreadyResponded indica que o Context já iniciou uma resposta; não prova que o Discord a recebeu. ErrNotResponded indica que você tentou uma operação posterior sem reconhecimento inicial. Erros de validação e rota devem falhar nos testes ou no bootstrap quando forem defeitos de configuração.

Persistência, migrações, filas, permissões de domínio e quotas pertencem à aplicação. O cookbook não adiciona esses serviços ao pacote raiz. Recursos do Discord sem suporte no discordgo fixado pelo go.mod não ganham suporte só por estarem embrulhados em Raw. Consulte a referência da biblioteca e as notas do upstream antes de experimentar componentes novos.

Voltar ao roteiro.