MessageTemplateDocument Class

The message template's document value information.

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

Constructor

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

Variables

Name	Description
name	str Template binding reference name. Required.
kind	str or <xref:azure.communication.messages.models.DOCUMENT> Message parameter type is document. Required. The document template parameter type.
url	str The (public) URL of the media. Required.
caption	str The [optional] caption of the media object.
file_name	str The [optional] filename of the media file.

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

caption

The [optional] caption of the media object.

caption: str | None

file_name

The [optional] filename of the media file.

file_name: str | None

kind

Message parameter type is document. Required. The document template parameter type.

kind: DOCUMENT: 'document'>]

name

Template binding reference name. Required.

name: str

url

The (public) URL of the media. Required.

url: str