NotificationFormat

class ansys.tools.common.notifications.NotificationFormat

Bases: str, enum.Enum

Body format of the notification.

Using a str enum means the values can be compared directly with the string constants used by the apprise library.

Overview

Attributes

TEXT	Plain text (default). Compatible with every notification channel.
HTML	HTML-formatted body. Rendered by channels that support it (e.g. email,
MARKDOWN	Markdown-formatted body. Rendered by channels that support it (e.g.

Import detail

from ansys.tools.common.notifications import NotificationFormat

Attribute detail

NotificationFormat.TEXT = 'text'

Plain text (default). Compatible with every notification channel.

NotificationFormat.HTML = 'html'

HTML-formatted body. Rendered by channels that support it (e.g. email, Slack). Channels that don’t support HTML will fall back to plain text.

NotificationFormat.MARKDOWN = 'markdown'

Markdown-formatted body. Rendered by channels that support it (e.g. Discord, Telegram, Slack). Falls back to plain text elsewhere.