Class Conversation

Hierarchy

Conversation

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Conversation(_agent: UA, _store: Store, _targetUri: string, mapper: NamespacedConversation, config?: ConversationConfiguration): Conversation

- Defined in src/models/conversation.ts:135
Parameters
- _agent: UA
- _store: Store
- _targetUri: string
- mapper: NamespacedConversation
- Optional config: ConversationConfiguration
Returns Conversation

Properties

Readonly id

id: string

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

Readonly isTest

isTest: boolean

Readonly mapper

mapper: NamespacedConversation

Accessors

created

get created(): undefined | Date

- Defined in src/models/conversation.ts:124
Date and time of the first sent/received message

Returns undefined | Date

messages

get messages(): Message[]

- Defined in src/models/conversation.ts:94
All messages that were sent or received

Returns Message[]

remoteDisplayName

get remoteDisplayName(): undefined | string

- Defined in src/models/conversation.ts:118
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

requestedUri

get requestedUri(): undefined | string

- Defined in src/models/conversation.ts:110
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

state

get state(): StateObject

- Defined in src/models/conversation.ts:100
Current conversation's state

Returns StateObject

targetUri

get targetUri(): string

- Defined in src/models/conversation.ts:133
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

Returns string

Methods

addMessageListener

addMessageListener(callback: (message: Message) => unknown): void

- Defined in src/models/conversation.ts:630
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
      - message: Message
      Returns unknown
Returns void

addStateListener

addStateListener(callback: (state: StateObject) => unknown): void

- Defined in src/models/conversation.ts:650
Registers a new listener for conversation state changes

Parameters
- callback: (state: StateObject) => unknown
  
  Callback function that is called each time the conversation's state changes
  - - (state: StateObject): unknown
    - Parameters
      - state: StateObject
      Returns unknown
Returns void

handleMessageEvent

handleMessageEvent(evt: IncomingMessageEvent | OutgoingMessageEvent): void

- Defined in src/models/conversation.ts:466
This function is only used internally and should not be called from outside the library

Parameters
- evt: IncomingMessageEvent | OutgoingMessageEvent
Returns void

removeMessageListener

removeMessageListener(callback: (message: Message) => unknown): void

- Defined in src/models/conversation.ts:639
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
      - message: Message
      Returns unknown
Returns void

removeStateListener

removeStateListener(callback: (state: StateObject) => unknown): void

- Defined in src/models/conversation.ts:659
Unregisters a previously registered conversation state listener

Parameters
- callback: (state: StateObject) => unknown
  
  Callback function that is called each time the conversation's state changes
  - - (state: StateObject): unknown
    - Parameters
      - state: StateObject
      Returns unknown
Returns void

sendMessage

sendMessage(__namedParameters: SendMessageObject): Message

- Defined in src/models/conversation.ts:400
Sends a text message

Parameters
- __namedParameters: SendMessageObject
Returns Message

start

start(sendMessageObj?: SendMessageObject): Message

- Defined in src/models/conversation.ts:370
Starts the conversation

This is basically a convenience function on top of sendMessage
It automatically sets the correct message type "START"
and defaults to text message "Start emergency call"

Parameters
- Optional sendMessageObj: SendMessageObject
Returns Message

stop

stop(sendMessageObj?: SendMessageObject): Message

- Defined in src/models/conversation.ts:387
Ends the conversation

This is basically a convenience function on top of sendMessage
It automatically sets the correct message type "STOP"
and defaults to text message "Stop emergency call"

Parameters
- Optional sendMessageObj: SendMessageObject
Returns Message

Static fromIncomingSipMessage

fromIncomingSipMessage(ua: UA, store: Store, mapper: NamespacedConversation, event: IncomingMessageEvent): Conversation

- Defined in src/models/conversation.ts:668
Creates a conversation out of an already existing SIP message (e.g. ETSI START message)

Parameters
- ua: UA
- store: Store
- mapper: NamespacedConversation
- event: IncomingMessageEvent
Returns Conversation

Generated using TypeDoc