airflow.providers.discord.notifications.embed¶

Discord embed structure.

See:: https://discord.com/developers/docs/resources/message#embed-object-embed-structure

Attributes¶

Classes¶

`EmbedFooter`	EmbedFooter.
`EmbedField`	EmbedField.
`EmbedProvider`	EmbedProvider.
`EmbedAuthor`	EmbedAuthor.
`Embed`	Embed.

Module Contents¶

airflow.providers.discord.notifications.embed.EmbedType[source]¶

class airflow.providers.discord.notifications.embed.EmbedFooter[source]¶

Bases: TypedDict

EmbedFooter.

Parameters:

text – Footer text.
icon_url – Url of footer icon (only supports http(s) and attachments).
proxy_icon_url – A proxy url of footer icon.

See:: https://discord.com/developers/docs/resources/message#embed-object-embed-footer-structure

text: str[source]¶

icon_url: typing_extensions.NotRequired[str][source]¶

proxy_icon_url: typing_extensions.NotRequired[str][source]¶

class airflow.providers.discord.notifications.embed.EmbedField[source]¶

Bases: TypedDict

EmbedField.

Parameters:

name – Name of the field.
value – Value of the field.
inline – Whether or not this field should display inline.

See:: https://discord.com/developers/docs/resources/message#embed-object-embed-field-structure

name: str[source]¶

value: str[source]¶

inline: typing_extensions.NotRequired[bool][source]¶

class airflow.providers.discord.notifications.embed.EmbedProvider[source]¶

Bases: TypedDict

EmbedProvider.

Parameters:

name – Name of provider
url – Url of provider

See:: https://discord.com/developers/docs/resources/message#embed-object-embed-provider-structure

name: str[source]¶

url: str[source]¶

class airflow.providers.discord.notifications.embed.EmbedAuthor[source]¶

Bases: TypedDict

EmbedAuthor.

Parameters:

name – Name of author.
url – Url of author (only supports http(s)).
icon_url – Url of author icon (only supports http(s) and attachments).
proxy_icon_url – A proxy url of author icon.

See:: https://discord.com/developers/docs/resources/message#embed-object-embed-author-structure

name: typing_extensions.Required[str][source]¶

url: str[source]¶

icon_url: str[source]¶

proxy_icon_url: str[source]¶

class airflow.providers.discord.notifications.embed.Embed[source]¶

Bases: TypedDict

Embed.

Parameters:

title – The text that is placed above the description. Embed titles are limited to 256 characters.
description – The part of the embed where most of the text is contained. Embed descriptions are limited to 2048 characters.
type – Type of embed (always “rich” for webhook embeds).
url – Url of embed.
timestamp – Timestamp (ISO8601) of embed content.
color – Color code of the embed.
footer – Footer information. Footer text is limited to 2048 characters
provider – Add provider information.
author – Adds the author block to the embed, always located at the top of the embed.
fields – Add fields information, max of 25 fields.

See:: https://discord.com/developers/docs/resources/message#embed-object-embed-author-structure

title: str[source]¶

description: str[source]¶

type: EmbedType[source]¶

url: str[source]¶

timestamp: str[source]¶

color: int[source]¶

footer: EmbedFooter[source]¶

provider: EmbedProvider[source]¶

author: EmbedAuthor[source]¶

fields: list[EmbedField][source]¶

Was this entry helpful?