The mapper for this environment for compatibility
Optional
config: ConversationConfigurationConfiguration object for additional conversation configuration
Optional
displayThe display name that's used for outgoing message This property is public intentionally, as PSAPs should have the possibility for setting this property, even if the conversation is already running
However, don't change displayName during an ongoing conversation as this can lead to unexpected behaviour! Use one and only one displayName throughout a conversation!
Readonly
idA unique conversation id
according to spec, 30 characters is the longest allowed string
Readonly
isDefines, whether the call should be marked as "silent" emergency call Currently only supported in DEC112 environments
Readonly
isDefines, whether the call should be marked as test call Currently only supported in DEC112 environments
Readonly
mapperThe mapper for this environment for compatibility
This is the target device we are communicating with -> the other communicating party e.g. if ng112-js is used as PSAP, this would be the SIP address of a mobile device
Date and time of the first sent/received message
Type of endpoint
Last used message id
Important for restoring conversations
This is the other communicating party's display name (if sent)
Keep in mind that this property is only set after the first remote message was processed!
This is the uri that was requested by the other communicating party
e.g. if ng112-js is used as PSAP, this would be the SIP address that was requested by the mobile device
This address can potentially differ from what ng112-js is using to register at the SIP proxy
Keep in mind that this property is only set after the first remote message was processed!
The final destination within the ESinet, derived from SIP Route header This property is most useful for PSAPs, as it represents the final routing decision made by ECRF, PRF ...
Registers a new listener for new incoming or outgoing messages
Registers a new listener for conversation state changes
Callback function that is called each time the conversation's state changes
This function is only used internally and should not be called from outside the library
A function which notifies all attached message listeners (can be used for deferred notifications)
Unregisters a previously registered message listener
Unregisters a previously registered conversation state listener
Callback function that is called each time the conversation's state changes
Sends a heartbeat message
This is basically a convenience function on top of sendMessage
It automatically sets the correct message type "HEARTBEAT"
Optional
sendMessageObj: SendMessageObjectSends a text message
Sends a text message
Starts the conversation
This is basically a convenience function on top of sendMessage
It automatically sets the correct message type "START"
Optional
sendMessageObj: SendMessageObjectEnds the conversation
This is basically a convenience function on top of sendMessage
It automatically sets the correct message type "STOP"
Optional
sendMessageObj: SendMessageObjectStatic
fromCreates a conversation out of an already existing SIP message (e.g. ETSI START message)
Generated using TypeDoc
This is the target device we are communicating with -> the other communicating party e.g. if ng112-js is used as PSAP, this would be the SIP address of a mobile device