Interface MessageConfig

Hierarchy

  • MessageConfig

Properties

binaries? conversation dateTime? did? event? extraHeaders? html? id location? multipart? origin promise state tag? text? type uris? vcard?

Properties

Optional binaries

binaries?: Binary[]

A list of binaries (files)

conversation

conversation: Conversation

The corresponding conversation

Optional dateTime

dateTime?: Date

Date and time when the message was sent/received

Optional did

did?: string

A decentralized identifier
For example, this identifier may resolve to credential about personal data

Optional event

event?: NewMessageEvent

Raw SIP event

Optional extraHeaders

extraHeaders?: Header[]

Additional SIP headers to be sent with the message

Optional html

html?: string

Chat message html

id

id: string | number

If message is outgoing (LOCAL): An incremental, unique id (parseable as number)
If message is incoming (REMOTE): A unique id
This is because according to the standard both unique numbers or strings are allowed
However, this library ALWAYS uses numbers for outgoing messages

Optional location

location?: PidfLo

The caller's vcard at time of sending the message

Optional multipart

multipart?: Multipart

A multipart object containing all the elements from the SIP body

origin

origin: Origin

Where the message was sent from (LOCAL or REMOTE)

promise

promise: Promise<void>

Promise that's resolved if the message was received by the other communicating party

state

state: MessageState

The message's state

Optional tag

tag?: any

A free to use property for internal identification and matching of messages This is helpful, if you want to use ng112-js as a PSAP and want to tag incoming messages

Optional text

text?: string

Chat message text

type

type: number

The ETSI TS 103 698 message type

Optional uris

uris?: string[]

A list of URIs

Optional vcard

vcard?: VCard

The caller's vcard at time of sending the message

Settings

Member Visibility

Theme

Generated using TypeDoc