Message¶

The Message is a persistent message or notification that is sent from one user to another.

The following is the list of all members included in the data schema.

Member	Description	Type	Default Value	Identifier	Unique	Required
`receiverUid`	The unique identifier of the user that is to receive the message.	`string`	`""`	false	false	true
`senderUid`	The unique identifier of the user that sent the message.	`string`	`""`	false	false	true
`subject`	The summary of the message contents.	`string`	`""`	false	false	true
`body`	The message contents.	`string`	`""`	false	false	true
`attachments`	A map of key-value pairs representing a list of attachments that have been appended to the message. The key of each pair is the name of the attachment and the value must be an encoded string. The string can represent any data including binary data using base64 encoding.	`any`	`undefined`	false	false	true

Examples¶

Members¶

receiverUid¶

Type: string

Default Value: ""

Required: true

The unique identifier of the user that is to receive the message.

senderUid¶

Type: string

Default Value: ""

Required: true

The unique identifier of the user that sent the message.

subject¶

Type: string

Default Value: ""

Required: true

The summary of the message contents.

body¶

Type: string

Default Value: ""

Required: true

The message contents.

attachments¶

Type: any

Default Value: undefined

Required: true

A map of key-value pairs representing a list of attachments that have been appended to the message. The key of each pair is the name of the attachment and the value must be an encoded string. The string can represent any data including binary data using base64 encoding.