DocumentNotificationContent Class

A request to send a document notification.

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

Constructor

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

Variables

Name	Description
channel_registration_id	str The Channel Registration ID for the Business Identifier. Required.
to	list[str] The native external platform user identifiers of the recipient. Required.
kind	str or <xref:azure.communication.messages.models.DOCUMENT> Message notification type is image. Required. Document message type.
caption	str Optional text content.
file_name	str Optional name for the file.
media_uri	str A media url for the file. Required if the type is one of the supported media types, e.g. image. 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

caption

Optional text content.

caption: str | None

channel_registration_id

The Channel Registration ID for the Business Identifier. Required.

channel_registration_id: str

file_name

Optional name for the file.

file_name: str | None

kind

Message notification type is image. Required. Document message type.

kind: DOCUMENT: 'document'>]

media_uri

A media url for the file. Required if the type is one of the supported media types, e.g. image. Required.

media_uri: str

to

The native external platform user identifiers of the recipient. Required.

to: List[str]