View¶

discord_http.view module¶

class discord_http.view.ActionRow(*components)¶

Bases: Item

Parameters:: components (Button | Select | Link)

add_item(item) → None¶

Add an item to the action row.

Parameters:: item (Button | Select | Link) – The item to add to the action row
Return type:: None

classmethod from_dict(data) → ActionRow¶

Returns an action row from a dict provided by Discord.

Return type:: ActionRow
Parameters:: data (dict)

remove_items(*, label=None, custom_id=None) → int¶

Remove items from the action row.

Parameters:

label (str | None) – Label of the item
custom_id (str | None) – Custom ID of the item

Return type:

int

Returns:

Returns the amount of items removed

to_dict() → dict¶

Returns a dict representation of the action row.

Return type:: dict

class discord_http.view.AttachmentComponent(*, state, data)¶

Bases: object

Parameters:

state (DiscordAPI)
data (dict)

async fetch(*, use_cached=False) → bytes¶

Fetches the file from the attachment URL and returns it as bytes.

Parameters:: use_cached (bool) – Whether to use the cached URL or not, defaults to False
Return type:: bytes
Returns:: The attachment as bytes
Raises:: HTTPException – If the request returned anything other than 2XX

async save(path, *, use_cached=False) → int¶

Fetches the file from the attachment URL and saves it locally to the path.

Parameters:

path (str) – Path to save the file to, which includes the filename and extension. Example: ./path/to/file.png
use_cached (bool) – Whether to use the cached URL or not, defaults to False

Return type:

int

Returns:

The amount of bytes written to the file

to_dict() → dict¶

The attachment as a dictionary.

Return type:: dict

async to_file(*, filename, spoiler=False) → File¶

Convert the attachment to a sendable File object for Message.send().

Parameters:

filename (str) – Filename for the file, if empty, the attachment’s filename will be used
spoiler (bool) – Weather the file should be marked as a spoiler or not, defaults to False

Return type:

File

Returns:

The attachment as a File object

class discord_http.view.Button(*, label=None, style=ButtonStyles.primary, disabled=False, custom_id=None, sku_id=None, emoji=None, url=None)¶

Bases: Item

Parameters:

label (str | None)
style (ButtonStyles | str | int)
disabled (bool)
custom_id (str | None)
sku_id (Snowflake | int | None)
emoji (str | dict | None)
url (str | None)

to_dict() → dict¶

Returns a dict representation of the button.

Return type:: dict

class discord_http.view.ChannelSelect(*channels, placeholder=None, custom_id=None, min_values=1, max_values=1, default_values=None, disabled=False)¶

Bases: Select

Parameters:

channels (ChannelType | BaseChannel)
placeholder (str | None)
custom_id (str | None)
min_values (int | None)
max_values (int | None)
default_values (list[BaseChannel | int] | None)
disabled (bool)

to_dict() → dict¶

Returns a dict representation of the channel select menu.

Return type:: dict

class discord_http.view.ContainerComponent(*items, colour=None, spoiler=None)¶

Bases: Item

Parameters:

items (Item)
colour (Colour | int | None)
spoiler (bool | None)

add_item(item) → Item¶

Add an item to the container component.

Parameters:: item (Item) – The item to add to the container component
Return type:: Item
Returns:: Returns the item that was added

remove_index(index) → Item | None¶

Remove an item from the container component.

Parameters:: index (int) – The index of the item to remove
Return type:: Item | None
Returns:: Returns whether the item was removed

to_dict() → dict¶

Returns a dict representation of the container component.

Return type:: dict

class discord_http.view.FileComponent(file, *, spoiler=False)¶

Bases: Item

Parameters:

file (Asset | AttachmentComponent | str)
spoiler (bool)

to_dict() → dict¶

Returns a dict representation of the file component.

Return type:: dict

class discord_http.view.Item(*, type)¶

Bases: object

Parameters:: type (ComponentType)

to_dict() → dict¶

Returns a dict representation of the item.

Return type:: dict

class discord_http.view.Link(*, url, label=None, emoji=None, disabled=False)¶

Bases: Button

Parameters:

url (str)
label (str | None)
emoji (str | None)
disabled (bool)

class discord_http.view.MediaGalleryComponent(*items)¶

Bases: Item

Parameters:: items (MediaGalleryItem | File | Asset)

add_item(item) → None¶

Add items to the media gallery.

Parameters:: item (MediaGalleryItem | File | Asset) – Items to add to the media gallery
Return type:: None

to_dict() → dict¶

Returns a dict representation of the media gallery component.

Return type:: dict

class discord_http.view.MediaGalleryItem(url, *, description=None, spoiler=False)¶

Bases: object

Parameters:

url (File | Asset | AttachmentComponent | str)
description (str | None)
spoiler (bool)

to_dict() → dict¶

Returns a dict representation of the media gallery item.

Return type:: dict

class discord_http.view.MentionableSelect(*, placeholder=None, custom_id=None, min_values=1, max_values=1, default_values=None, disabled=False)¶

Bases: Select

Parameters:

placeholder (str | None)
custom_id (str | None)
min_values (int | None)
max_values (int | None)
default_values (list[Member | Role | int] | None)
disabled (bool)

class discord_http.view.Modal(*, title, custom_id=None)¶

Bases: InteractionStorage

Parameters:

title (str)
custom_id (str | None)

add_item(*, label, custom_id=None, style=None, placeholder=None, min_length=None, max_length=None, default=None, required=True) → ModalItem¶

Add an item to the modal.

Parameters:

label (str) – Label of the item
custom_id (str | None) – Custom ID of the item
style (TextStyles | None) – Style of the item
placeholder (str | None) – Placeholder of the item
min_length (int | None) – Minimum length of the item
max_length (int | None) – Maximum length of the item
default (str | None) – Default value of the item
required (bool) – Whether the item is required

Return type:

ModalItem

Returns:

Returns the created modal item from the items list

to_dict() → dict¶

Returns a dict representation of the modal.

Return type:: dict

class discord_http.view.ModalItem(*, label, custom_id=None, style=None, placeholder=None, min_length=None, max_length=None, default=None, required=True)¶

Bases: object

Parameters:

label (str)
custom_id (str | None)
style (TextStyles | None)
placeholder (str | None)
min_length (int | None)
max_length (int | None)
default (str | None)
required (bool)

to_dict() → dict¶

Returns a dict representation of the modal item.

Return type:: dict

class discord_http.view.Premium(sku_id)¶

Bases: Button

Parameters:: sku_id (Snowflake | int)

class discord_http.view.RoleSelect(*, placeholder=None, custom_id=None, min_values=1, max_values=1, default_values=None, disabled=False)¶

Bases: Select

Parameters:

placeholder (str | None)
custom_id (str | None)
min_values (int | None)
max_values (int | None)
default_values (list[Role | int] | None)
disabled (bool)

class discord_http.view.SectionComponent(*components, accessory)¶

Bases: Item

Parameters:

components (TextDisplayComponent | str)
accessory (Button | ThumbnailComponent | AttachmentComponent | Asset | File)

to_dict() → dict¶

Returns a dict representation of the section component.

Return type:: dict

class discord_http.view.Select(*, placeholder=None, custom_id=None, min_values=1, max_values=1, disabled=False, options=None, _type=None)¶

Bases: Item

Parameters:

placeholder (str | None)
custom_id (str | None)
min_values (int | None)
max_values (int | None)
disabled (bool)
options (list[dict] | None)
_type (ComponentType | None)

add_item(*, label, value, description=None, emoji=None, default=False) → None¶

Add an item to the select menu.

Parameters:

label (str) – Label of the item
value (str) – The value of the item, which will be shown on interaction response
description (str | None) – Description of the item
emoji (str | None) – Emoji shown on the left side of the item
default (bool) – Whether the item is selected by default

Raises:

ValueError – If there are more than 25 options

Return type:

None

to_dict() → dict¶

Returns a dict representation of the select menu.

Return type:: dict

class discord_http.view.SeparatorComponent(*, spacing=None, divider=None)¶

Bases: Item

Parameters:

spacing (SeparatorSpacingType | None)
divider (bool | None)

to_dict() → dict¶

Returns a dict representation of the separator.

Return type:: dict

class discord_http.view.TextDisplayComponent(content)¶

Bases: Item

Parameters:: content (str)

to_dict() → dict¶

Returns a dict representation of the text display.

Return type:: dict

class discord_http.view.ThumbnailComponent(url, *, description=None, spoiler=False)¶

Bases: Item

Parameters:

url (Asset | AttachmentComponent | str)
description (str | None)
spoiler (bool)

to_dict() → dict¶

Returns a dict representation of the thumbnail.

Return type:: dict

class discord_http.view.UserSelect(*, placeholder=None, custom_id=None, min_values=1, max_values=1, default_values=None, disabled=False)¶

Bases: Select

Parameters:

placeholder (str | None)
custom_id (str | None)
min_values (int | None)
max_values (int | None)
default_values (list[Member | int] | None)
disabled (bool)

class discord_http.view.View(*items)¶

Bases: InteractionStorage

Parameters:: items (Item)

add_item(item) → Item¶

Add an item to the view.

Parameters:: item (Item) – The item to add to the view
Return type:: Item
Returns:: Returns the added item

classmethod from_dict(*, state, data) → View¶

Returns a view from a dict provided by Discord.

Return type:

View

Parameters:

state (DiscordAPI)
data (dict)

get_item(*, label=None, custom_id=None) → Item | None¶

Get an item from the view that matches the parameters.

Parameters:

label (str | None) – Label of the item
custom_id (str | None) – Custom ID of the item

Return type:

Item | None

Returns:

Returns the item if found, otherwise None

remove_items(*, label=None, custom_id=None) → int¶

Remove items from the view that match the parameters.

Parameters:

label (str | None) – Label of the item
custom_id (str | None) – Custom ID of the item

Return type:

int

Returns:

Returns the amount of items removed

to_dict() → list[dict]¶

Returns a dict representation of the view.

Return type:: list[dict]