Hierarchy

  • Conversation

Constructors

Properties

displayName?: string

The 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!

id: string

A unique conversation id
according to spec, 30 characters is the longest allowed string

isSilent: boolean

Defines, whether the call should be marked as "silent" emergency call Currently only supported in DEC112 environments

isTest: boolean

Defines, whether the call should be marked as test call Currently only supported in DEC112 environments

mapper: Mapper

The mapper for this environment for compatibility

targetUri: string

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

Accessors

  • get remoteDisplayName(): undefined | string
  • 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!

    Returns undefined | string

  • get requestedUri(): undefined | string
  • 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!

    Returns undefined | string

  • get routeUri(): undefined | string
  • 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 ...

    Returns undefined | string

Methods

  • Registers a new listener for new incoming or outgoing messages

    Parameters

    • callback: ((message: Message) => unknown)

      Callback function that is called each time a new incoming or outgoing message is received/sent

        • (message: Message): unknown
        • Parameters

          Returns unknown

    Returns void

  • Unregisters a previously registered message listener

    Parameters

    • callback: ((message: Message) => unknown)

      Callback function that is called each time a new incoming or outgoing message is received/sent

        • (message: Message): unknown
        • Parameters

          Returns unknown

    Returns void

  • Unregisters a previously registered conversation state listener

    Parameters

    • callback: ((state: StateObject) => unknown)

      Callback function that is called each time the conversation's state changes

    Returns void

Generated using TypeDoc