MessageTemplateLocation Class

The message template's location value information.

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

Constructor

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

Variables

Name	Description
name	str Template binding reference name. Required.
kind	str or <xref:azure.communication.messages.models.LOCATION> Message parameter type is location. Required. The location template parameter type.
location_name	str The [Optional] name of the location.
address	str The [Optional] address of the location.
latitude	float The latitude of the location. Required.
longitude	float The longitude of the location. Required.

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

address

The [Optional] address of the location.

address: str | None

kind

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

kind: LOCATION: 'location'>]

latitude

The latitude of the location. Required.

latitude: float

location_name

The [Optional] name of the location.

location_name: str | None

longitude

The longitude of the location. Required.

longitude: float

name

Template binding reference name. Required.

name: str