hikari/api/special_endpoints.py
# -*- coding: utf-8 -*-
# cython: language_level=3
# Copyright (c) 2020 Nekokatt
# Copyright (c) 2021-present davfsa
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
"""Special additional endpoints used by the REST API."""
from __future__ import annotations
__all__: typing.Sequence[str] = (
"AutocompleteChoiceBuilder",
"ButtonBuilder",
"CommandBuilder",
"SlashCommandBuilder",
"ContextMenuCommandBuilder",
"ComponentBuilder",
"TypingIndicator",
"GuildBuilder",
"InteractionAutocompleteBuilder",
"InteractionDeferredBuilder",
"InteractionResponseBuilder",
"InteractionMessageBuilder",
"InteractiveButtonBuilder",
"LinkButtonBuilder",
"SelectMenuBuilder",
"TextSelectMenuBuilder",
"ChannelSelectMenuBuilder",
"SelectOptionBuilder",
"TextInputBuilder",
"InteractionModalBuilder",
"MessageActionRowBuilder",
"ModalActionRowBuilder",
)
import abc
import typing
from hikari import components as components_
from hikari import undefined
if typing.TYPE_CHECKING:
import types
from typing_extensions import Self
from hikari import channels
from hikari import colors
from hikari import commands
from hikari import embeds as embeds_
from hikari import emojis
from hikari import files
from hikari import guilds
from hikari import locales
from hikari import messages
from hikari import permissions as permissions_
from hikari import snowflakes
from hikari import users
from hikari import voices
from hikari.api import entity_factory as entity_factory_
from hikari.api import rest as rest_api
from hikari.interactions import base_interactions
from hikari.internal import time
_ParentT = typing.TypeVar("_ParentT")
class TypingIndicator(abc.ABC):
"""Result type of [`hikari.api.rest.RESTClient.trigger_typing`][].
This is an object that can either be awaited like a coroutine to trigger
the typing indicator once, or an async context manager to keep triggering
the typing indicator repeatedly until the context finishes.
!!! note
This is a helper class that is used by [`hikari.api.rest.RESTClient`][].
You should only ever need to use instances of this class that are
produced by that API.
"""
__slots__: typing.Sequence[str] = ()
@abc.abstractmethod
def __await__(self) -> typing.Generator[None, typing.Any, None]: ...
@abc.abstractmethod
async def __aenter__(self) -> None: ...
@abc.abstractmethod
async def __aexit__(
self,
exception_type: typing.Type[BaseException],
exception: BaseException,
exception_traceback: types.TracebackType,
) -> None: ...
class GuildBuilder(abc.ABC):
"""Result type of [`hikari.api.rest.RESTClient.guild_builder`][].
This is used to create a guild in a tidy way using the HTTP API, since
the logic behind creating a guild on an API level is somewhat confusing
and detailed.
!!! note
If you call [`hikari.api.special_endpoints.GuildBuilder.add_role`][], the default roles provided by Discord will
be created. This also applies to the `add_` functions for
text channels/voice channels/categories.
!!! note
Functions that return a [`hikari.snowflakes.Snowflake`][] do
**not** provide the final ID that the object will have once the
API call is made. The returned IDs are only able to be used to
re-reference particular objects while building the guild format
to allow for the creation of channels within categories,
and to provide permission overwrites.
Examples
--------
Creating an empty guild:
```py
guild = await rest.guild_builder("My Server!").create()
```
Creating a guild with an icon:
```py
from hikari.files import WebResourceStream
guild_builder = rest.guild_builder("My Server!")
guild_builder.icon = WebResourceStream("cat.png", "http://...")
guild = await guild_builder.create()
```
Adding roles to your guild:
```py
from hikari.permissions import Permissions
guild_builder = rest.guild_builder("My Server!")
everyone_role_id = guild_builder.add_role("@everyone")
admin_role_id = guild_builder.add_role("Admins", permissions=Permissions.ADMINISTRATOR)
await guild_builder.create()
```
!!! warning
The first role must always be the `@everyone` role.
Adding a text channel to your guild:
```py
guild_builder = rest.guild_builder("My Server!")
category_id = guild_builder.add_category("My safe place")
channel_id = guild_builder.add_text_channel("general", parent_id=category_id)
await guild_builder.create()
```
"""
__slots__: typing.Sequence[str] = ()
@property
@abc.abstractmethod
def name(self) -> str:
"""Name of the guild to create."""
@property
@abc.abstractmethod
def default_message_notifications(self) -> undefined.UndefinedOr[guilds.GuildMessageNotificationsLevel]:
"""Default message notification level that can be overwritten.
If not overridden, this will use the Discord default level.
"""
@default_message_notifications.setter
def default_message_notifications(
self, default_message_notifications: undefined.UndefinedOr[guilds.GuildMessageNotificationsLevel], /
) -> None:
raise NotImplementedError
@property
@abc.abstractmethod
def explicit_content_filter_level(self) -> undefined.UndefinedOr[guilds.GuildExplicitContentFilterLevel]:
"""Explicit content filter level that can be overwritten.
If not overridden, this will use the Discord default level.
"""
@explicit_content_filter_level.setter
def explicit_content_filter_level(
self, explicit_content_filter_level: undefined.UndefinedOr[guilds.GuildExplicitContentFilterLevel], /
) -> None:
raise NotImplementedError
@property
@abc.abstractmethod
def icon(self) -> undefined.UndefinedOr[files.Resourceish]:
"""Guild icon to use that can be overwritten.
If not overridden, the guild will not have an icon.
"""
@icon.setter
def icon(self, icon: undefined.UndefinedOr[files.Resourceish], /) -> None:
raise NotImplementedError
@property
@abc.abstractmethod
def verification_level(self) -> undefined.UndefinedOr[typing.Union[guilds.GuildVerificationLevel, int]]:
"""Verification level required to join the guild."""
@verification_level.setter
def verification_level(
self, verification_level: undefined.UndefinedOr[typing.Union[guilds.GuildVerificationLevel, int]], /
) -> None:
raise NotImplementedError
@abc.abstractmethod
async def create(self) -> guilds.RESTGuild:
"""Send the request to Discord to create the guild.
The application user will be added to this guild as soon as it is
created. All IDs that were provided when building this guild will
become invalid and will be replaced with real IDs.
Returns
-------
hikari.guilds.RESTGuild
The created guild.
Raises
------
hikari.errors.BadRequestError
If any values set in the guild builder are invalid.
hikari.errors.UnauthorizedError
If you are unauthorized to make the request (invalid/missing token).
hikari.errors.ForbiddenError
If you are already in 10 guilds.
hikari.errors.InternalServerError
If an internal error occurs on Discord while handling the request.
"""
@abc.abstractmethod
def add_role(
self,
name: str,
/,
*,
permissions: undefined.UndefinedOr[permissions_.Permissions] = undefined.UNDEFINED,
color: undefined.UndefinedOr[colors.Colorish] = undefined.UNDEFINED,
colour: undefined.UndefinedOr[colors.Colorish] = undefined.UNDEFINED,
hoist: undefined.UndefinedOr[bool] = undefined.UNDEFINED,
mentionable: undefined.UndefinedOr[bool] = undefined.UNDEFINED,
position: undefined.UndefinedOr[int] = undefined.UNDEFINED,
) -> snowflakes.Snowflake:
"""Create a role.
!!! warning
The first role you create (i.e., position 0) must always be the
`@everyone` role.
Parameters
----------
name
The role's name.
permissions
If provided, the permissions for the role.
color
If provided, the role's color.
colour
An alias for `color`.
hoist
If provided, whether to hoist the role.
mentionable
If provided, whether to make the role mentionable.
position
If provided, the position of the role.
Returns
-------
hikari.snowflakes.Snowflake
The dummy ID for this role that can be used temporarily to refer
to this object while designing the guild layout.
When the guild is created, this will be replaced with a different
ID.
Raises
------
ValueError
If you are defining the first role, but did not name it `@everyone`.
TypeError
If you specify both `color` and `colour` together or if you try to
specify `color`, `colour`, `hoisted`, `mentionable` or `position` for
the `@everyone` role.
"""
@abc.abstractmethod
def add_category(
self,
name: str,
/,
*,
position: undefined.UndefinedOr[int] = undefined.UNDEFINED,
permission_overwrites: undefined.UndefinedOr[
typing.Collection[channels.PermissionOverwrite]
] = undefined.UNDEFINED,
) -> snowflakes.Snowflake:
"""Create a category channel.
Parameters
----------
name
The channels name. Must be between 2 and 1000 characters.
position
If provided, the position of the category.
permission_overwrites
If provided, the permission overwrites for the category.
Returns
-------
hikari.snowflakes.Snowflake
The dummy ID for this channel that can be used temporarily to refer
to this object while designing the guild layout.
When the guild is created, this will be replaced with a different
ID.
"""
@abc.abstractmethod
def add_text_channel(
self,
name: str,
/,
*,
parent_id: undefined.UndefinedOr[snowflakes.Snowflake] = undefined.UNDEFINED,
topic: undefined.UndefinedOr[str] = undefined.UNDEFINED,
rate_limit_per_user: undefined.UndefinedOr[time.Intervalish] = undefined.UNDEFINED,
position: undefined.UndefinedOr[int] = undefined.UNDEFINED,
permission_overwrites: undefined.UndefinedOr[
typing.Collection[channels.PermissionOverwrite]
] = undefined.UNDEFINED,
nsfw: undefined.UndefinedOr[bool] = undefined.UNDEFINED,
) -> snowflakes.Snowflake:
"""Create a text channel.
Parameters
----------
name
The channels name. Must be between 2 and 1000 characters.
position
If provided, the position of the channel (relative to the
category, if any).
topic
If provided, the channels topic. Maximum 1024 characters.
nsfw
If provided, whether to mark the channel as NSFW.
rate_limit_per_user
If provided, the amount of seconds a user has to wait
before being able to send another message in the channel.
Maximum 21600 seconds.
permission_overwrites
If provided, the permission overwrites for the channel.
parent_id
The ID of the category to create the channel under.
Returns
-------
hikari.snowflakes.Snowflake
The dummy ID for this channel that can be used temporarily to refer
to this object while designing the guild layout.
When the guild is created, this will be replaced with a different
ID.
"""
@abc.abstractmethod
def add_voice_channel(
self,
name: str,
/,
*,
parent_id: undefined.UndefinedOr[snowflakes.Snowflake] = undefined.UNDEFINED,
bitrate: undefined.UndefinedOr[int] = undefined.UNDEFINED,
video_quality_mode: undefined.UndefinedOr[typing.Union[channels.VideoQualityMode, int]] = undefined.UNDEFINED,
position: undefined.UndefinedOr[int] = undefined.UNDEFINED,
permission_overwrites: undefined.UndefinedOr[
typing.Collection[channels.PermissionOverwrite]
] = undefined.UNDEFINED,
region: undefined.UndefinedNoneOr[typing.Union[voices.VoiceRegion, str]],
user_limit: undefined.UndefinedOr[int] = undefined.UNDEFINED,
) -> snowflakes.Snowflake:
"""Create a voice channel.
Parameters
----------
name
The channels name. Must be between 2 and 1000 characters.
position
If provided, the position of the channel (relative to the
category, if any).
user_limit
If provided, the maximum users in the channel at once.
Must be between 0 and 99 with 0 meaning no limit.
bitrate
If provided, the bitrate for the channel. Must be
between 8000 and 96000 or 8000 and 128000 for VIP
servers.
video_quality_mode
If provided, the new video quality mode for the channel.
permission_overwrites
If provided, the permission overwrites for the channel.
region
If provided, the voice region to for this channel. Passing
[`None`][] here will set it to "auto" mode where the used
region will be decided based on the first person who connects to it
when it's empty.
parent_id
The ID of the category to create the channel under.
Returns
-------
hikari.snowflakes.Snowflake
The dummy ID for this channel that can be used temporarily to refer
to this object while designing the guild layout.
When the guild is created, this will be replaced with a different
ID.
"""
@abc.abstractmethod
def add_stage_channel(
self,
name: str,
/,
*,
parent_id: undefined.UndefinedOr[snowflakes.Snowflake] = undefined.UNDEFINED,
bitrate: undefined.UndefinedOr[int] = undefined.UNDEFINED,
position: undefined.UndefinedOr[int] = undefined.UNDEFINED,
permission_overwrites: undefined.UndefinedOr[
typing.Collection[channels.PermissionOverwrite]
] = undefined.UNDEFINED,
region: undefined.UndefinedNoneOr[typing.Union[voices.VoiceRegion, str]],
user_limit: undefined.UndefinedOr[int] = undefined.UNDEFINED,
) -> snowflakes.Snowflake:
"""Create a stage channel.
Parameters
----------
name
The channels name. Must be between 2 and 1000 characters.
position
If provided, the position of the channel (relative to the
category, if any).
user_limit
If provided, the maximum users in the channel at once.
Must be between 0 and 99 with 0 meaning no limit.
bitrate
If provided, the bitrate for the channel. Must be
between 8000 and 96000 or 8000 and 128000 for VIP
servers.
permission_overwrites
If provided, the permission overwrites for the channel.
region
If provided, the voice region to for this channel. Passing
[`None`][] here will set it to "auto" mode where the used
region will be decided based on the first person who connects to it
when it's empty.
parent_id
The ID of the category to create the channel under.
Returns
-------
hikari.snowflakes.Snowflake
The dummy ID for this channel that can be used temporarily to refer
to this object while designing the guild layout.
When the guild is created, this will be replaced with a different
ID.
"""
class InteractionResponseBuilder(abc.ABC):
"""Base class for all interaction response builders used in the interaction server."""
__slots__: typing.Sequence[str] = ()
@property
@abc.abstractmethod
def type(self) -> typing.Union[int, base_interactions.ResponseType]:
"""Type of this response."""
@abc.abstractmethod
def build(
self, entity_factory: entity_factory_.EntityFactory, /
) -> typing.Tuple[typing.MutableMapping[str, typing.Any], typing.Sequence[files.Resource[files.AsyncReader]]]:
"""Build a JSON object from this builder.
Parameters
----------
entity_factory
The entity factory to use to serialize entities within this builder.
Returns
-------
typing.Tuple[typing.MutableMapping[str, typing.Any], typing.Sequence[files.Resource[Files.AsyncReader]]
A tuple of the built json object representation of this builder and
a sequence of up to 10 files to send with the response.
"""
class InteractionDeferredBuilder(InteractionResponseBuilder, abc.ABC):
"""Interface of a deferred message interaction response builder."""
__slots__: typing.Sequence[str] = ()
@property
@abc.abstractmethod
def type(self) -> base_interactions.DeferredResponseTypesT:
"""Type of this response."""
@property
@abc.abstractmethod
def flags(self) -> typing.Union[undefined.UndefinedType, int, messages.MessageFlag]:
"""Message flags this response should have.
!!! note
As of writing the only message flags which can be set here are
[`hikari.messages.MessageFlag.EPHEMERAL`][], [`hikari.messages.MessageFlag.SUPPRESS_NOTIFICATIONS`][]
and [`hikari.messages.MessageFlag.SUPPRESS_EMBEDS`][].
"""
@abc.abstractmethod
def set_flags(self, flags: typing.Union[undefined.UndefinedType, int, messages.MessageFlag], /) -> Self:
"""Set message flags for this response.
!!! note
As of writing, the only message flags which can be set are [`hikari.messages.MessageFlag.EPHEMERAL`][]
[`hikari.messages.MessageFlag.SUPPRESS_NOTIFICATIONS`][] and
[`hikari.messages.MessageFlag.SUPPRESS_EMBEDS`][].
Parameters
----------
flags
The message flags to set for this response.
Returns
-------
InteractionMessageBuilder
Object of this builder.
"""
class AutocompleteChoiceBuilder(abc.ABC):
"""Interface of an autocomplete choice used to respond to interactions."""
__slots__: typing.Sequence[str] = ()
@property
@abc.abstractmethod
def name(self) -> str:
"""The choice's name."""
@property
@abc.abstractmethod
def value(self) -> typing.Union[int, str, float]:
"""The choice's value."""
@abc.abstractmethod
def set_name(self, name: str, /) -> Self:
"""Set this choice's name.
Returns
-------
AutocompleteChoiceBuilder
The autocomplete choice builder.
"""
@abc.abstractmethod
def set_value(self, value: typing.Union[int, float, str], /) -> Self:
"""Set this choice's value.
Returns
-------
AutocompleteChoiceBuilder
The autocomplete choice builder.
"""
@abc.abstractmethod
def build(self) -> typing.MutableMapping[str, typing.Any]:
"""Build a JSON object from this builder.
Returns
-------
typing.MutableMapping[str, typing.Any]
The built json object representation of this builder.
"""
class InteractionAutocompleteBuilder(InteractionResponseBuilder, abc.ABC):
"""Interface of an autocomplete interaction response builder."""
__slots__: typing.Sequence[str] = ()
@property
@abc.abstractmethod
def choices(self) -> typing.Sequence[AutocompleteChoiceBuilder]:
"""Autocomplete choices."""
@abc.abstractmethod
def set_choices(self, choices: typing.Sequence[AutocompleteChoiceBuilder], /) -> Self:
"""Set autocomplete choices.
Parameters
----------
choices
The choices to set.
Returns
-------
InteractionAutocompleteBuilder
Object of this builder.
"""
class InteractionMessageBuilder(InteractionResponseBuilder, abc.ABC):
"""Interface of an interaction message response builder used within REST servers.
This can be returned by the listener registered to
[`hikari.api.interaction_server.InteractionServer`][] as a response to the interaction
create.
"""
__slots__: typing.Sequence[str] = ()
# Required fields
@property
@abc.abstractmethod
def type(self) -> base_interactions.MessageResponseTypesT:
"""Type of this response."""
# Extendable fields
@property
@abc.abstractmethod
def attachments(self) -> undefined.UndefinedNoneOr[typing.Sequence[files.Resourceish]]:
"""Sequence of up to 10 attachments to send with the message."""
@property
@abc.abstractmethod
def components(self) -> undefined.UndefinedNoneOr[typing.Sequence[ComponentBuilder]]:
"""Sequence of up to 5 component builders to send in this response."""
@property
@abc.abstractmethod
def embeds(self) -> undefined.UndefinedNoneOr[typing.Sequence[embeds_.Embed]]:
"""Sequence of up to 10 of the embeds included in this response."""
# Settable fields
@property
@abc.abstractmethod
def content(self) -> undefined.UndefinedNoneOr[str]:
"""Response's message content."""
@property
@abc.abstractmethod
def flags(self) -> typing.Union[undefined.UndefinedType, int, messages.MessageFlag]:
"""Message flags this response should have.
!!! note
As of writing the only message flags which can be set here are
[`hikari.messages.MessageFlag.EPHEMERAL`][],
[`hikari.messages.MessageFlag.SUPPRESS_NOTIFICATIONS`][]
and [`hikari.messages.MessageFlag.SUPPRESS_EMBEDS`][].
"""
@property
@abc.abstractmethod
def is_tts(self) -> undefined.UndefinedOr[bool]:
"""Whether this response's content should be treated as text-to-speech."""
@property
@abc.abstractmethod
def mentions_everyone(self) -> undefined.UndefinedOr[bool]:
"""Whether @everyone and @here mentions should be enabled for this response."""
@property
@abc.abstractmethod
def role_mentions(
self,
) -> undefined.UndefinedOr[typing.Union[snowflakes.SnowflakeishSequence[guilds.PartialRole], bool]]:
"""Whether and what role mentions should be enabled for this response.
Either a sequence of object/IDs of the roles mentions should be enabled
for, [`False`][] or [`hikari.undefined.UNDEFINED`][] to disallow any
role mentions or [`True`][] to allow all role mentions.
"""
@property
@abc.abstractmethod
def user_mentions(
self,
) -> undefined.UndefinedOr[typing.Union[snowflakes.SnowflakeishSequence[users.PartialUser], bool]]:
"""Whether and what user mentions should be enabled for this response.
Either a sequence of object/IDs of the users mentions should be enabled
for, [`False`][] or [`hikari.undefined.UNDEFINED`][] to disallow any
user mentions or [`True`][] to allow all user mentions.
"""
@abc.abstractmethod
def clear_attachments(self, /) -> Self:
"""Clear attachments for this response.
This is only useful for message update responses, where you might want to
remove all existing attachments.
Returns
-------
InteractionMessageBuilder
Object of this builder.
"""
@abc.abstractmethod
def add_attachment(self, attachment: files.Resourceish, /) -> Self:
"""Add an attachment to this response.
Parameters
----------
attachment
The attachment to add.
Returns
-------
InteractionMessageBuilder
Object of this builder.
"""
@abc.abstractmethod
def add_component(self, component: ComponentBuilder, /) -> Self:
"""Add a component to this response.
Parameters
----------
component
The component builder to add to this response.
Returns
-------
InteractionMessageBuilder
Object of this builder.
"""
@abc.abstractmethod
def add_embed(self, embed: embeds_.Embed, /) -> Self:
"""Add an embed to this response.
Parameters
----------
embed
Object of the embed to add to this response.
Returns
-------
InteractionMessageBuilder
Object of this builder to allow for chained calls.
"""
@abc.abstractmethod
def set_content(self, content: undefined.UndefinedOr[str], /) -> Self:
"""Set the response's message content.
Parameters
----------
content
The message content to set for this response.
Returns
-------
InteractionMessageBuilder
Object of this builder to allow for chained calls.
"""
@abc.abstractmethod
def set_flags(self, flags: typing.Union[undefined.UndefinedType, int, messages.MessageFlag], /) -> Self:
"""Set message flags for this response.
!!! note
As of writing, the only message flags which can be set is
[`hikari.messages.MessageFlag.EPHEMERAL`][] and [`hikari.messages.MessageFlag.SUPPRESS_NOTIFICATIONS`][].
Parameters
----------
flags
The message flags to set for this response.
Returns
-------
InteractionMessageBuilder
Object of this builder to allow for chained calls.
"""
@abc.abstractmethod
def set_tts(self, tts: undefined.UndefinedOr[bool], /) -> Self:
"""Set whether this response should trigger text-to-speech processing.
Parameters
----------
tts
Whether this response should trigger text-to-speech processing.
Returns
-------
InteractionMessageBuilder
Object of this builder to allow for chained calls.
"""
@abc.abstractmethod
def set_mentions_everyone(self, mentions: undefined.UndefinedOr[bool] = undefined.UNDEFINED, /) -> Self:
"""Set whether this response should be able to mention @everyone/@here.
Parameters
----------
mentions
Whether this response should be able to mention @everyone/@here.
Returns
-------
InteractionMessageBuilder
Object of this builder to allow for chained calls.
"""
@abc.abstractmethod
def set_role_mentions(
self,
mentions: undefined.UndefinedOr[
typing.Union[snowflakes.SnowflakeishSequence[guilds.PartialRole], bool]
] = undefined.UNDEFINED,
/,
) -> Self:
"""Set whether and what role mentions should be possible for this response.
Parameters
----------
mentions
Either a sequence of object/IDs of the roles mentions should be enabled for,
[`False`][] or [`hikari.undefined.UNDEFINED`][] to disallow any role
mentions or [`True`][] to allow all role mentions.
Returns
-------
InteractionMessageBuilder
Object of this builder to allow for chained calls.
"""
@abc.abstractmethod
def set_user_mentions(
self,
mentions: undefined.UndefinedOr[
typing.Union[snowflakes.SnowflakeishSequence[users.PartialUser], bool]
] = undefined.UNDEFINED,
/,
) -> Self:
"""Set whether and what user mentions should be possible for this response.
Parameters
----------
mentions
Either a sequence of object/IDs of the users mentions should be enabled for,
[`False`][] or [`hikari.undefined.UNDEFINED`][] to disallow any user
mentions or [`True`][] to allow all user mentions.
Returns
-------
InteractionMessageBuilder
Object of this builder to allow for chained calls.
"""
class InteractionModalBuilder(InteractionResponseBuilder, abc.ABC):
"""Interface of an interaction modal response builder used within REST servers.
This can be returned by the listener registered to
[`hikari.api.interaction_server.InteractionServer`][] as a response to the interaction
create.
"""
__slots__: typing.Sequence[str] = ()
@property
@abc.abstractmethod
def type(self) -> typing.Literal[base_interactions.ResponseType.MODAL]:
"""Type of this response."""
@property
@abc.abstractmethod
def title(self) -> str:
"""Title that will show up in the modal."""
@property
@abc.abstractmethod
def custom_id(self) -> str:
"""Developer set custom ID used for identifying interactions with this modal."""
@property
@abc.abstractmethod
def components(self) -> undefined.UndefinedOr[typing.Sequence[ComponentBuilder]]:
"""Sequence of component builders to send in this modal."""
@abc.abstractmethod
def set_title(self, title: str, /) -> Self:
"""Set the title that will show up in the modal.
Parameters
----------
title
The title that will show up in the modal.
"""
@abc.abstractmethod
def set_custom_id(self, custom_id: str, /) -> Self:
"""Set the custom ID used for identifying interactions with this modal.
Parameters
----------
custom_id
The developer set custom ID used for identifying interactions with this modal.
"""
@abc.abstractmethod
def add_component(self, component: ComponentBuilder, /) -> Self:
"""Add a component to this modal.
Parameters
----------
component
The component builder to add to this modal.
"""
class InteractionPremiumRequiredBuilder(InteractionResponseBuilder, abc.ABC):
"""Interface of an interaction premium required response builder used within REST servers.
This can be returned by the listener registered to
`hikari.api.interaction_server.InteractionServer` as a response to the interaction
create.
"""
__slots__: typing.Sequence[str] = ()
@property
@abc.abstractmethod
def type(self) -> typing.Literal[base_interactions.ResponseType.PREMIUM_REQUIRED]:
"""Type of this response."""
class CommandBuilder(abc.ABC):
"""Interface of a command builder used when bulk creating commands over REST."""
__slots__: typing.Sequence[str] = ()
@property
@abc.abstractmethod
def name(self) -> str:
r"""Name to set for this command.
!!! warning
This should match the regex `^[-_\p{L}\p{N}\p{sc=Deva}\p{sc=Thai}]{1,32}$` in Unicode mode
and must be lowercase.
"""
@property
@abc.abstractmethod
def type(self) -> commands.CommandType:
"""Type of this command."""
@property
@abc.abstractmethod
def id(self) -> undefined.UndefinedOr[snowflakes.Snowflake]:
"""ID of this command."""
@property
@abc.abstractmethod
def default_member_permissions(self) -> typing.Union[undefined.UndefinedType, permissions_.Permissions, int]:
"""Member permissions necessary to utilize this command by default.
If `0`, then it will be available for all members. Note that this doesn't affect
administrators of the guild and overwrites.
"""
@property
@abc.abstractmethod
def is_dm_enabled(self) -> undefined.UndefinedOr[bool]:
"""Whether this command is enabled in DMs with the bot.
Only applicable to globally-scoped commands.
"""
@property
@abc.abstractmethod
def is_nsfw(self) -> undefined.UndefinedOr[bool]:
"""Whether this command age-restricted."""
@property
@abc.abstractmethod
def name_localizations(self) -> typing.Mapping[typing.Union[locales.Locale, str], str]:
"""Name localizations set for this command."""
@abc.abstractmethod
def set_name(self, name: str, /) -> Self:
"""Set the name of this command.
Parameters
----------
name
The name to set for this command.
Returns
-------
CommandBuilder
Object of this command builder to allow for chained calls.
"""
@abc.abstractmethod
def set_id(self, id_: undefined.UndefinedOr[snowflakes.Snowflakeish], /) -> Self:
"""Set the ID of this command.
Parameters
----------
id_
The ID to set for this command.
Returns
-------
CommandBuilder
Object of this command builder to allow for chained calls.
"""
@abc.abstractmethod
def set_default_member_permissions(
self, default_member_permissions: typing.Union[undefined.UndefinedType, int, permissions_.Permissions], /
) -> Self:
"""Set the member permissions necessary to utilize this command by default.
Parameters
----------
default_member_permissions
The default member permissions to utilize this command by default.
If `0`, then it will be available for all members. Note that this doesn't affect
administrators of the guild and overwrites.
Returns
-------
CommandBuilder
Object of this command builder.
"""
@abc.abstractmethod
def set_is_dm_enabled(self, state: undefined.UndefinedOr[bool], /) -> Self:
"""Set whether this command will be enabled in DMs with the bot.
Parameters
----------
state
Whether this command is enabled in DMs with the bot.
Returns
-------
CommandBuilder
Object of this command builder to allow for chained calls.
"""
@abc.abstractmethod
def set_is_nsfw(self, state: undefined.UndefinedOr[bool], /) -> Self:
"""Set whether this command will be age-restricted.
Parameters
----------
state
Whether this command is age-restricted.
Returns
-------
CommandBuilder
Object of this command builder for chained calls.
"""
@abc.abstractmethod
def set_name_localizations(
self, name_localizations: typing.Mapping[typing.Union[locales.Locale, str], str], /
) -> Self:
"""Set the name localizations for this command.
Parameters
----------
name_localizations
The name localizations to set for this command.
Returns
-------
CommandBuilder
Object of this command builder.
"""
@abc.abstractmethod
def build(self, entity_factory: entity_factory_.EntityFactory, /) -> typing.MutableMapping[str, typing.Any]:
"""Build a JSON object from this builder.
Parameters
----------
entity_factory
The entity factory to use to serialize entities within this builder.
Returns
-------
typing.MutableMapping[str, typing.Any]
The built json object representation of this builder.
"""
@abc.abstractmethod
async def create(
self,
rest: rest_api.RESTClient,
application: snowflakes.SnowflakeishOr[guilds.PartialApplication],
/,
*,
guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED,
) -> commands.PartialCommand:
"""Create this command through a REST call.
Parameters
----------
rest
The REST client to use to make this request.
application
The application to create this command for.
guild
The guild to create this command for.
If left undefined then this command will be declared globally.
Returns
-------
hikari.commands.PartialCommand
The created command.
"""
class SlashCommandBuilder(CommandBuilder):
"""SlashCommandBuilder."""
__slots__: typing.Sequence[str] = ()
@property
@abc.abstractmethod
def description(self) -> str:
"""Command's description.
!!! warning
This should be inclusively between 1-100 characters in length.
"""
@property
@abc.abstractmethod
def description_localizations(self) -> typing.Mapping[typing.Union[locales.Locale, str], str]:
"""Command's localised descriptions."""
@property
@abc.abstractmethod
def options(self) -> typing.Sequence[commands.CommandOption]:
"""Sequence of up to 25 of the options set for this command."""
@abc.abstractmethod
def set_description(self, description: str, /) -> Self:
"""Set the description for this command.
Parameters
----------
description
The description to set for this command.
Returns
-------
SlashCommandBuilder
Object of this command builder.
"""
@abc.abstractmethod
def set_description_localizations(
self, description_localizations: typing.Mapping[typing.Union[locales.Locale, str], str], /
) -> Self:
"""Set the localised descriptions for this command.
Parameters
----------
description_localizations
The description localizations to set for this command.
Returns
-------
SlashCommandBuilder
Object of this command builder.
"""
@abc.abstractmethod
def add_option(self, option: commands.CommandOption) -> Self:
"""Add an option to this command.
!!! note
A command can have up to 25 options.
Parameters
----------
option
The option to add to this command.
Returns
-------
SlashCommandBuilder
Object of this command builder to allow for chained calls.
"""
@abc.abstractmethod
async def create(
self,
rest: rest_api.RESTClient,
application: snowflakes.SnowflakeishOr[guilds.PartialApplication],
/,
*,
guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED,
) -> commands.SlashCommand:
"""Create this command through a REST call.
This is a shorthand for calling [`hikari.api.rest.RESTClient.create_slash_command`][]
with the builder's information.
Parameters
----------
rest
The REST client to use to make this request.
application
The application to create this command for.
guild
The guild to create this command for.
If left undefined then this command will be declared globally.
Returns
-------
hikari.commands.SlashCommand
The created command.
"""
class ContextMenuCommandBuilder(CommandBuilder):
"""ContextMenuCommandBuilder."""
__slots__: typing.Sequence[str] = ()
@abc.abstractmethod
async def create(
self,
rest: rest_api.RESTClient,
application: snowflakes.SnowflakeishOr[guilds.PartialApplication],
/,
*,
guild: undefined.UndefinedOr[snowflakes.SnowflakeishOr[guilds.PartialGuild]] = undefined.UNDEFINED,
) -> commands.ContextMenuCommand:
"""Create this command through a REST call.
This is a shorthand for calling
[`hikari.api.rest.RESTClient.create_context_menu_command`][]
with the builder's information.
Parameters
----------
rest
The REST client to use to make this request.
application
The application to create this command for.
guild
The guild to create this command for.
If left undefined then this command will be declared globally.
Returns
-------
hikari.commands.ContextMenuCommand
The created command.
"""
class ComponentBuilder(abc.ABC):
"""Base class for all component builder classes."""
__slots__: typing.Sequence[str] = ()
@property
@abc.abstractmethod
def type(self) -> typing.Union[int, components_.ComponentType]:
"""Type of component this builder represents."""
@abc.abstractmethod
def build(self) -> typing.MutableMapping[str, typing.Any]:
"""Build a JSON object from this builder.
Returns
-------
typing.MutableMapping[str, typing.Any]
The built json object representation of this builder.
"""
class ButtonBuilder(ComponentBuilder, abc.ABC):
"""Builder class for a message button component."""
__slots__: typing.Sequence[str] = ()
@property
@abc.abstractmethod
def type(self) -> typing.Literal[components_.ComponentType.BUTTON]:
"""Type of component this builder represents."""
@property
@abc.abstractmethod
def style(self) -> typing.Union[components_.ButtonStyle, int]:
"""Button's style."""
@property
@abc.abstractmethod
def emoji(self) -> typing.Union[snowflakes.Snowflakeish, emojis.Emoji, str, undefined.UndefinedType]:
"""Emoji which should appear on this button."""
@property
@abc.abstractmethod
def label(self) -> undefined.UndefinedOr[str]:
"""Text label which should appear on this button.
!!! note
The text label to that should appear on this button. This may be
up to 80 characters long.
"""
@property
@abc.abstractmethod
def is_disabled(self) -> bool:
"""Whether the button should be marked as disabled."""
@abc.abstractmethod
def set_emoji(
self, emoji: typing.Union[snowflakes.Snowflakeish, emojis.Emoji, str, undefined.UndefinedType], /
) -> Self:
"""Set the emoji to display on this button.
Parameters
----------
emoji
Object, ID or raw string of the emoji which should be displayed on
this button.
Returns
-------
ButtonBuilder
The builder object to enable chained calls.
"""
@abc.abstractmethod
def set_label(self, label: undefined.UndefinedOr[str], /) -> Self:
"""Set the text label which should be displayed on this button.
Parameters
----------
label
The text label to show on this button.
This may be up to 80 characters long.
Returns
-------
ButtonBuilder
The builder object to enable chained calls.
"""
@abc.abstractmethod
def set_is_disabled(self, state: bool, /) -> Self:
"""Set whether this button should be disabled.
Parameters
----------
state
Whether this button should be disabled.
Returns
-------
ButtonBuilder
The builder object to enable chained calls.
"""
class LinkButtonBuilder(ButtonBuilder, abc.ABC):
"""Builder interface for link buttons."""
__slots__: typing.Sequence[str] = ()
@property
@abc.abstractmethod
def url(self) -> str:
"""URL this button should link to when pressed."""
class InteractiveButtonBuilder(ButtonBuilder, abc.ABC):
"""Builder interface for interactive buttons."""
__slots__: typing.Sequence[str] = ()
@property
@abc.abstractmethod
def custom_id(self) -> str:
"""Developer set custom ID used for identifying interactions with this button."""
@abc.abstractmethod
def set_custom_id(self, custom_id: str, /) -> Self:
"""Set the custom ID used for identifying this button.
Parameters
----------
custom_id
Developer set custom ID used for identifying this button.
Returns
-------
InteractiveButtonBuilder
The builder object to enable chained calls.
"""
class SelectOptionBuilder(abc.ABC):
"""Builder class for select menu options."""
__slots__: typing.Sequence[str] = ()
@property
@abc.abstractmethod
def label(self) -> str:
"""User-facing name of the option, max 100 characters."""
@property
@abc.abstractmethod
def value(self) -> str:
"""Developer-defined value of the option, max 100 characters."""
@property
@abc.abstractmethod
def description(self) -> undefined.UndefinedOr[str]:
"""Description of the option, max 100 characters."""
@property
@abc.abstractmethod
def emoji(self) -> typing.Union[snowflakes.Snowflakeish, emojis.Emoji, str, undefined.UndefinedType]:
"""Emoji which should appear on this option."""
@property
@abc.abstractmethod
def is_default(self) -> bool:
"""Whether this option should be marked as selected by default."""
@abc.abstractmethod
def set_label(self, label: str, /) -> Self:
"""Set the option's label.
Parameters
----------
label
Label to set for this option. This can be up to 100 characters
long.
Returns
-------
SelectOptionBuilder
The builder object to enable chained calls.
"""
@abc.abstractmethod
def set_value(self, value: str, /) -> Self:
"""Set the option's value.
Parameters
----------
value
Value to set for this option. This can be up to 100 characters
long.
Returns
-------
SelectOptionBuilder
The builder object to enable chained calls.
"""
@abc.abstractmethod
def set_description(self, value: undefined.UndefinedOr[str], /) -> Self:
"""Set the option's description.
Parameters
----------
value
Description to set for this option. This can be up to 100 characters
long.
Returns
-------
SelectOptionBuilder
The builder object to enable chained calls.
"""
@abc.abstractmethod
def set_emoji(
self, emoji: typing.Union[snowflakes.Snowflakeish, emojis.Emoji, str, undefined.UndefinedType], /
) -> Self:
"""Set the emoji to display on this option.
Parameters
----------
emoji
Object, ID or raw string of the emoji which should be displayed on
this option.
Returns
-------
SelectOptionBuilder
The builder object to enable chained calls.
"""
@abc.abstractmethod
def set_is_default(self, state: bool, /) -> Self:
"""Set whether this option should be selected by default.
Parameters
----------
state
Whether this option should be selected by default.
Returns
-------
SelectOptionBuilder
The builder object to enable chained calls.
"""
@abc.abstractmethod
def build(self) -> typing.MutableMapping[str, typing.Any]:
"""Build a JSON object from this builder.
Returns
-------
typing.MutableMapping[str, typing.Any]
The built json object representation of this builder.
"""
class SelectMenuBuilder(ComponentBuilder, abc.ABC):
"""Builder class for a select menu."""
__slots__: typing.Sequence[str] = ()
@property
@abc.abstractmethod
def custom_id(self) -> str:
"""Developer set custom ID used for identifying interactions with this menu."""
@property
@abc.abstractmethod
def is_disabled(self) -> bool:
"""Whether the select menu should be marked as disabled."""
@property
@abc.abstractmethod
def placeholder(self) -> undefined.UndefinedOr[str]:
"""Placeholder text to display when no options are selected."""
@property
@abc.abstractmethod
def min_values(self) -> int:
"""Minimum number of options which must be chosen.
Defaults to 1.
Must be less than or equal to [`hikari.api.special_endpoints.SelectMenuBuilder.max_values`][] and greater
than or equal to 0.
"""
@property
@abc.abstractmethod
def max_values(self) -> int:
"""Maximum number of options which can be chosen.
Defaults to 1.
Must be greater than or equal to [`hikari.api.special_endpoints.SelectMenuBuilder.min_values`][] and
less than or equal to 25.
"""
@abc.abstractmethod
def set_custom_id(self, custom_id: str, /) -> Self:
"""Set the custom ID used for identifying this menu.
Parameters
----------
custom_id
Developer set custom ID used for identifying this menu.
Returns
-------
SelectMenuBuilder
The builder object to enable chained calls.
"""
@abc.abstractmethod
def set_is_disabled(self, state: bool, /) -> Self:
"""Set whether this option is disabled.
Parameters
----------
state
Whether this option is disabled.
Returns
-------
SelectMenuBuilder
The builder object to enable chained calls.
"""
@abc.abstractmethod
def set_placeholder(self, value: undefined.UndefinedOr[str], /) -> Self:
"""Set place-holder text to be shown when no option is selected.
Parameters
----------
value
Place-holder text to be displayed when no option is selected.
Max 100 characters.
Returns
-------
SelectMenuBuilder
The builder object to enable chained calls.
"""
@abc.abstractmethod
def set_min_values(self, value: int, /) -> Self:
"""Set the minimum amount of options which need to be selected for this menu.
!!! note
This defaults to 1 if not set and must be greater than or equal to 0
and less than or equal to [`hikari.api.special_endpoints.SelectMenuBuilder.max_values`][].
Parameters
----------
value
The minimum amount of options which need to be selected for this menu.
Returns
-------
SelectMenuBuilder
The builder object to enable chained calls.
"""
@abc.abstractmethod
def set_max_values(self, value: int, /) -> Self:
"""Set the maximum amount of options which can be selected for this menu.
!!! note
This defaults to 1 if not set and must be less than or equal to 25
and greater than or equal to [`hikari.api.special_endpoints.SelectMenuBuilder.min_values`][].
Parameters
----------
value
The maximum amount of options which can selected for this menu.
Returns
-------
SelectMenuBuilder
The builder object to enable chained calls.
"""
class TextSelectMenuBuilder(SelectMenuBuilder, abc.ABC, typing.Generic[_ParentT]):
"""Builder class for a text select menu."""
__slots__: typing.Sequence[str] = ()
@property
@abc.abstractmethod
def parent(self) -> _ParentT:
"""Parent object which initialised this builder."""
@property
@abc.abstractmethod
def options(self) -> typing.Sequence[SelectOptionBuilder]:
"""Sequence of the options set for this select menu."""
@abc.abstractmethod
def add_option(
self,
label: str,
value: str,
/,
*,
description: undefined.UndefinedOr[str] = undefined.UNDEFINED,
emoji: typing.Union[snowflakes.Snowflakeish, emojis.Emoji, str, undefined.UndefinedType] = undefined.UNDEFINED,
is_default: bool = False,
) -> Self:
"""Add an option to this menu.
Parameters
----------
label
The user-facing name of this option, max 100 characters.
value
The developer defined value of this option, max 100 characters.
description
The option's description.
This can be up to 100 characters long.
emoji
The option's display emoji.
is_default
Whether this option should be selected by default.
Returns
-------
TextSelectMenuBuilder
The select menu builder to enable call chaining.
"""
class ChannelSelectMenuBuilder(SelectMenuBuilder, abc.ABC):
"""Builder class for a channel select menu."""
__slots__: typing.Sequence[str] = ()
@property
@abc.abstractmethod
def channel_types(self) -> typing.Sequence[channels.ChannelType]:
"""The channel types that can be selected in this menu."""
@abc.abstractmethod
def set_channel_types(self, value: typing.Sequence[channels.ChannelType], /) -> Self:
"""Set the valid channel types for this menu.
Parameters
----------
value
The valid channel types for this menu.
Returns
-------
SelectMenuBuilder
The builder object to enable chained calls.
"""
class TextInputBuilder(ComponentBuilder, abc.ABC):
"""Builder class for text inputs components."""
__slots__: typing.Sequence[str] = ()
@property
@abc.abstractmethod
def type(self) -> typing.Literal[components_.ComponentType.TEXT_INPUT]:
"""Type of component this builder represents."""
@property
@abc.abstractmethod
def custom_id(self) -> str:
"""Developer set custom ID used for identifying this text input.
!!! note
This custom_id is never used in component interaction events.
It is meant to be used purely for resolving components modal interactions.
"""
@property
@abc.abstractmethod
def label(self) -> str:
"""Label above this text input."""
@property
@abc.abstractmethod
def style(self) -> components_.TextInputStyle:
"""Style to use for the text input."""
@property
@abc.abstractmethod
def placeholder(self) -> undefined.UndefinedOr[str]:
"""Placeholder text for when the text input is empty."""
@property
@abc.abstractmethod
def value(self) -> undefined.UndefinedOr[str]:
"""Pre-filled text that will be sent if the user does not write anything."""
@property
@abc.abstractmethod
def is_required(self) -> bool:
"""Whether this text input is required to be filled-in."""
@property
@abc.abstractmethod
def min_length(self) -> int:
"""Minimum length the text should have."""
@property
@abc.abstractmethod
def max_length(self) -> int:
"""Maximum length the text should have."""
@abc.abstractmethod
def set_style(self, style: typing.Union[components_.TextInputStyle, int], /) -> Self:
"""Set the style to use for the text input.
Parameters
----------
style
Style to use for the text input.
Returns
-------
TextInputBuilder
The builder object to enable chained calls.
"""
@abc.abstractmethod
def set_custom_id(self, custom_id: str, /) -> Self:
"""Set the custom ID used for identifying this text input.
Parameters
----------
custom_id
Developer set custom ID used for identifying this text input.
Returns
-------
TextInputBuilder
The builder object to enable chained calls.
"""
@abc.abstractmethod
def set_label(self, label: str, /) -> Self:
"""Set the label above this text input.
Parameters
----------
label
Label above this text input.
Returns
-------
TextInputBuilder
The builder object to enable chained calls.
"""
@abc.abstractmethod
def set_placeholder(self, placeholder: undefined.UndefinedOr[str], /) -> Self:
"""Set the placeholder text for when the text input is empty.
Parameters
----------
placeholder
Placeholder text that will disappear when the user types anything.
Returns
-------
TextInputBuilder
The builder object to enable chained calls.
"""
@abc.abstractmethod
def set_value(self, value: undefined.UndefinedOr[str], /) -> Self:
"""Pre-filled text that will be sent if the user does not write anything.
Parameters
----------
value
Pre-filled text that will be sent if the user does not write anything.
Returns
-------
TextInputBuilder
The builder object to enable chained calls.
"""
@abc.abstractmethod
def set_required(self, required: bool, /) -> Self:
"""Set whether this text input is required to be filled-in.
Parameters
----------
required
Whether this text input is required to be filled-in.
Returns
-------
TextInputBuilder
The builder object to enable chained calls.
"""
@abc.abstractmethod
def set_min_length(self, min_length: int, /) -> Self:
"""Set the minimum length the text should have.
Parameters
----------
min_length
The minimum length the text should have.
Returns
-------
TextInputBuilder
The builder object to enable chained calls.
"""
@abc.abstractmethod
def set_max_length(self, max_length: int, /) -> Self:
"""Set the maximum length the text should have.
Parameters
----------
max_length
The maximum length the text should have.
Returns
-------
TextInputBuilder
The builder object to enable chained calls.
"""
class MessageActionRowBuilder(ComponentBuilder, abc.ABC):
"""Builder class for action row components."""
__slots__: typing.Sequence[str] = ()
@property
@abc.abstractmethod
def type(self) -> typing.Literal[components_.ComponentType.ACTION_ROW]:
"""Type of component this builder represents."""
@property
@abc.abstractmethod
def components(self) -> typing.Sequence[ComponentBuilder]:
"""Sequence of the component builders registered within this action row."""
@abc.abstractmethod
def add_component(self, component: ComponentBuilder, /) -> Self:
"""Add a component to this action row builder.
!!! warning
It is generally better to use
[`hikari.api.special_endpoints.MessageActionRowBuilder.add_interactive_button`][]
and [`hikari.api.special_endpoints.MessageActionRowBuilder.add_select_menu`][]
to add your component to the builder. Those methods utilize this one.
Parameters
----------
component
The component builder to add to the action row.
Returns
-------
ActionRowBuilder
The builder object to enable chained calls.
"""
@abc.abstractmethod
def add_interactive_button(
self,
style: components_.InteractiveButtonTypesT,
custom_id: str,
/,
*,
emoji: typing.Union[snowflakes.Snowflakeish, emojis.Emoji, str, undefined.UndefinedType] = undefined.UNDEFINED,
label: undefined.UndefinedOr[str] = undefined.UNDEFINED,
is_disabled: bool = False,
) -> Self:
"""Add an interactive button component to this action row builder.
Either `emoji` or `label` (exclusively) must be provided to be the button's
displayed label.
Parameters
----------
style
The button's style.
custom_id
The developer-defined custom identifier used to identify which button
triggered component interactions.
emoji
The button's display emoji.
label
The button's display label.
is_disabled
Whether the button should be marked as disabled.
Returns
-------
ActionRowBuilder
The action row builder to enable chained calls.
"""
@abc.abstractmethod
def add_link_button(
self,
url: str,
/,
*,
emoji: typing.Union[snowflakes.Snowflakeish, emojis.Emoji, str, undefined.UndefinedType] = undefined.UNDEFINED,
label: undefined.UndefinedOr[str] = undefined.UNDEFINED,
is_disabled: bool = False,
) -> Self:
"""Add a link button component to this action row builder.
Either `emoji` or `label` (exclusively) must be provided to be the button's
displayed label.
Parameters
----------
url
The URL the link button should redirect to.
emoji
The button's display emoji.
label
The button's display label.
is_disabled
Whether the button should be marked as disabled.
Returns
-------
ActionRowBuilder
The action row builder to enable chained calls.
"""
@abc.abstractmethod
def add_select_menu(
self,
type_: typing.Union[components_.ComponentType, int],
custom_id: str,
/,
*,
placeholder: undefined.UndefinedOr[str] = undefined.UNDEFINED,
min_values: int = 0,
max_values: int = 1,
is_disabled: bool = False,
) -> Self:
"""Add a select menu component to this action row builder.
For channel select menus and text select menus see
[`hikari.api.special_endpoints.MessageActionRowBuilder.add_channel_menu`][]
and [`hikari.api.special_endpoints.MessageActionRowBuilder.add_text_menu`][].
Parameters
----------
type_
The type for the select menu.
custom_id
A developer-defined custom identifier used to identify which menu
triggered component interactions.
placeholder
Placeholder text to show when no entries have been selected.
min_values
The minimum amount of entries which need to be selected.
max_values
The maximum amount of entries which can be selected.
is_disabled
Whether this select menu should be marked as disabled.
Returns
-------
ActionRowBuilder
The action row builder to enable chained calls.
Raises
------
ValueError
If an invalid select menu type is passed.
"""
@abc.abstractmethod
def add_channel_menu(
self,
custom_id: str,
/,
*,
channel_types: typing.Sequence[channels.ChannelType] = (),
placeholder: undefined.UndefinedOr[str] = undefined.UNDEFINED,
min_values: int = 0,
max_values: int = 1,
is_disabled: bool = False,
) -> Self:
"""Add a channel select menu component to this action row builder.
Parameters
----------
custom_id
A developer-defined custom identifier used to identify which menu
triggered component interactions.
channel_types
The channel types this select menu should allow.
If left as an empty sequence then there will be no
channel type restriction.
placeholder
Placeholder text to show when no entries have been selected.
min_values
The minimum amount of entries which need to be selected.
max_values
The maximum amount of entries which can be selected.
is_disabled
Whether this select menu should be marked as disabled.
Returns
-------
ActionRowBuilder
The action row builder to enable chained calls.
Raises
------
ValueError
If an invalid select menu type is passed.
"""
@abc.abstractmethod
def add_text_menu(
self,
custom_id: str,
/,
*,
placeholder: undefined.UndefinedOr[str] = undefined.UNDEFINED,
min_values: int = 0,
max_values: int = 1,
is_disabled: bool = False,
) -> TextSelectMenuBuilder[Self]:
"""Add a select menu component to this action row builder.
Parameters
----------
custom_id
A developer-defined custom identifier used to identify which menu
triggered component interactions.
placeholder
Placeholder text to show when no entries have been selected.
min_values
The minimum amount of entries which need to be selected.
max_values
The maximum amount of entries which can be selected.
is_disabled
Whether this select menu should be marked as disabled.
Returns
-------
TextSelectMenuBuilder
The text select menu builder.
[`hikari.api.special_endpoints.TextSelectMenuBuilder.add_option`][] should be called to add
options to the returned builder then
[`hikari.api.special_endpoints.TextSelectMenuBuilder.parent`][] can be used to return to this
action row while chaining calls.
Raises
------
ValueError
If an invalid select menu type is passed.
"""
class ModalActionRowBuilder(ComponentBuilder, abc.ABC):
"""Builder class for modal action row components."""
__slots__: typing.Sequence[str] = ()
@property
@abc.abstractmethod
def type(self) -> typing.Literal[components_.ComponentType.ACTION_ROW]:
"""Type of component this builder represents."""
@property
@abc.abstractmethod
def components(self) -> typing.Sequence[ComponentBuilder]:
"""Sequence of the component builders registered within this action row."""
@abc.abstractmethod
def add_component(self, component: ComponentBuilder, /) -> Self:
"""Add a component to this action row builder.
!!! warning
It is generally better to use
[`hikari.api.special_endpoints.MessageActionRowBuilder.add_interactive_button`][]
and [`hikari.api.special_endpoints.MessageActionRowBuilder.add_select_menu`][]
to add your component to the builder. Those methods utilize this one.
Parameters
----------
component
The component builder to add to the action row.
Returns
-------
ActionRowBuilder
The builder object to enable chained calls.
"""
@abc.abstractmethod
def add_text_input(
self,
custom_id: str,
label: str,
/,
*,
style: components_.TextInputStyle = components_.TextInputStyle.SHORT,
placeholder: undefined.UndefinedOr[str] = undefined.UNDEFINED,
value: undefined.UndefinedOr[str] = undefined.UNDEFINED,
required: bool = True,
min_length: int = 0,
max_length: int = 4000,
) -> Self:
"""Add a text input component to this action row builder.
Parameters
----------
custom_id
Developer set custom ID used for identifying this text input.
label
Label above this text input.
style
The text input's style.
placeholder
Placeholder text to display when the text input is empty.
value
Default text to pre-fill the field with.
required
Whether text must be supplied for this text input.
min_length
Minimum length the input text can be.
This can be greater than or equal to 0 and less than or equal to 4000.
max_length
Maximum length the input text can be.
This can be greater than or equal to 1 and less than or equal to 4000.
Returns
-------
ModalActionRowBuilder
The modal action row builder to enable call chaining.
"""