MessageTemplate Class

The template object used to create templates.

All required parameters must be populated in order to send to server.

Constructor

MessageTemplate(*args: Any, **kwargs: Any)

Variables

Name	Description
name	str Name of the template. Required.
language	str The template's language, in the ISO 639 format, consist of a two-letter language code followed by an optional two-letter country code, e.g., 'en' or 'en_US'. Required.
template_values	list[MessageTemplateValue] The template values.
bindings	MessageTemplateBindings The binding object to link values to the template specific locations.

Methods

as_dict	Return a dict that can be JSONify using json.dump.
clear
copy
get
items
keys
pop
popitem
setdefault
update
values

as_dict

Return a dict that can be JSONify using json.dump.

as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties.

Returns

Type	Description
dict	A dict JSON compatible object

clear

clear() -> None

copy

copy() -> Model

get

get(key: str, default: Any = None) -> Any

Parameters

Name	Description
key Required
default Required	Default value: None

items

items() -> ItemsView[str, Any]

keys

keys() -> KeysView[str]

pop

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default Required

popitem

popitem() -> Tuple[str, Any]

setdefault

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default Required

update

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Attributes

bindings

The binding object to link values to the template specific locations.

bindings: _models.MessageTemplateBindings | None

language

The template's language, in the ISO 639 format, consist of a two-letter language code followed by an optional two-letter country code, e.g., 'en' or 'en_US'. Required.

language: str

name

Name of the template. Required.

name: str

template_values

The template values.

template_values: List[_models.MessageTemplateValue] | None