MessageTemplateValue Class

The class describes a parameter of a template.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: MessageTemplateDocument, MessageTemplateImage, MessageTemplateLocation, MessageTemplateQuickAction, MessageTemplateText, MessageTemplateVideo

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

Constructor

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

Variables

Name	Description
name	str Template binding reference name. Required.
kind	str or MessageTemplateValueKind The type discriminator describing a template parameter type. Required. Known values are: "text", "image", "document", "video", "location", and "quickAction".

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

kind

The type discriminator describing a template parameter type. Required. Known values are: "text", "image", "document", "video", "location", and "quickAction".

kind: str

name

Template binding reference name. Required.

name: str