Skip to content

TextPartValue

Source code in docs_src/capo_notifications/types/text_part_value.py 
15
16
17
18
19
20
21
22
23
class TextPartValue(TypedDict, closed=True):
    type: "capo_notifications.types.text_part_type.TextPartType"
    """<p>The type of text part. Determines the usage of all other fields and whether or not they're required.</p>"""
    display_text: NotRequired["str"]
    """<p>A short single line description of the link. Must be hyper-linked with the URL itself. </p> <p>Used for text parts with the type <code>URL</code>.</p>"""
    text_by_locale: NotRequired["capo_notifications.types.text_by_locale.TextByLocale"]
    """<p>A map of locales to the text in that locale.</p>"""
    url: NotRequired["capo_notifications.types.url.Url"]
    """<p>The URL itself.</p>"""

display_text instance-attribute 

display_text: NotRequired[str]

A short single line description of the link. Must be hyper-linked with the URL itself.

Used for text parts with the type URL.

text_by_locale instance-attribute 

text_by_locale: NotRequired[TextByLocale]

A map of locales to the text in that locale.

type instance-attribute 

type: TextPartType

The type of text part. Determines the usage of all other fields and whether or not they're required.

url instance-attribute 

url: NotRequired[Url]

The URL itself.