Benutzer-, Nachrichten- und Einstiegspunkt-Befehle¶

Neben Slash-Befehlen kennt Discord Befehle, die aus dem Kontextmenü eines Benutzers oder einer Nachricht ausgeführt werden, und den Einstiegspunkt-Befehl, der die Aktivität einer App öffnet.

Benutzer- und Nachrichtenbefehle¶

import bostie
from bostie import Context, Message, ResolvedMember, User, WebhookMessage, fmt

bot = bostie.Bot()


@bot.user_command("Account age")
async def account_age(ctx: Context, user: User) -> None:
    created = fmt.timestamp(user.created_at, "R")
    await ctx.respond(f"{user.mention} joined Discord {created}.", ephemeral=True)


@bot.user_command("Joined server")
async def joined(ctx: Context, member: ResolvedMember) -> None:
    if member.joined_at is None:
        await ctx.respond(f"Discord sent no join date for {member.mention}.")
        return
    await ctx.respond(f"{member.mention} joined {fmt.timestamp(member.joined_at)}.")


@bot.message_command("Word count")
async def word_count(ctx: Context, message: Message | WebhookMessage) -> None:
    await ctx.respond(f"{len(message.content.split())} words.", ephemeral=True)

@bot.user_command(name) und @bot.message_command(name) registrieren eine Funktion, die den Kontext und das Ziel entgegennimmt. Der Name ist das, was das Menü anzeigt: 1 bis 32 Zeichen, und anders als bei Slash-Befehlen darf er Großbuchstaben und Leerzeichen enthalten. Diese Befehle haben keine Beschreibung und keine Optionen.

Der Type Hint des Ziels legt fest, was der Handler bekommt:

Ein Ziel, das sich nicht in den angegebenen Typ auflösen lässt, löst OptionConversionError aus, das an die Fehler-Hooks geht. Gib einem Nachrichtenziel den Hint Message | WebhookMessage, es sei denn, der Befehl ergibt nur für eine der beiden Arten Sinn.

Sie nehmen die Einstellungen eines Slash-Befehls außer description, description_localizations und den Optionseinstellungen: name_localizations, ephemeral, auto_defer, default_permissions, nsfw, guilds, contexts, integration_types, checks und extra. Discord erlaubt 15 Benutzer- und 15 Nachrichtenbefehle pro Geltungsbereich, und die Synchronisierung warnt, wenn es mehr sind.

Der Einstiegspunkt-Befehl¶

Eine App mit Aktivitäten hat genau einen Einstiegspunkt-Befehl, den der App Launcher anzeigt. @bot.entry_point(name) registriert ihn mit einer Funktion, die nur den Kontext entgegennimmt:

import bostie
from bostie import Context

bot = bostie.Bot()


@bot.entry_point("Launch", description="Open the game")
async def launch(ctx: Context) -> None:
    await ctx.launch_activity()

Der Handler antwortet wie bei jedem Befehl: ctx.launch_activity() öffnet die Aktivität und gibt die ID ihrer Instanz zurück, und ctx.respond(...) antwortet stattdessen mit einer Nachricht. Discord lehnt den Befehl ab, wenn für die App im Developer Portal keine Aktivitäten aktiviert sind.

Der Einstiegspunkt ist immer global. Ist dev_guilds gesetzt, lässt die Synchronisierung ihn weg und warnt. Hat Discord bereits seinen Standard-Einstiegspunkt unter einem anderen Namen, behält die Synchronisierung die ID dieses Befehls, damit Discord ihn ersetzt, statt beide zu behalten. launch_activity() gibt es auch an Komponenten- und Modal-Kontexten, dort muss es aber die erste Antwort sein.

entry_point nimmt description, name_localizations, description_localizations, ephemeral, auto_defer, default_permissions, nsfw, contexts, integration_types, checks und extra. Aktivitäten, Monetarisierung und das Social SDK behandelt den Rest der Aktivitäten-Seite.