Class DefaultMessagingSession

Hierarchy

DefaultMessagingSession

Implements

MessagingSession

Index

Constructors

constructor

Methods

Constructors

constructor

new DefaultMessagingSession(configuration: MessagingSessionConfiguration, logger: Logger, webSocket?: WebSocketAdapter, reconnectController?: ReconnectController, sigV4?: SigV4): DefaultMessagingSession

- Defined in src/messagingsession/DefaultMessagingSession.ts:29
Parameters
- configuration: MessagingSessionConfiguration
- logger: Logger
- Optional webSocket: WebSocketAdapter
- Optional reconnectController: ReconnectController
- Optional sigV4: SigV4
Returns DefaultMessagingSession

Methods

addObserver

addObserver(observer: MessagingSessionObserver): void

Implementation of MessagingSession.addObserver
- Defined in src/messagingsession/DefaultMessagingSession.ts:60
Add an observer.

Parameters
- observer: MessagingSessionObserver
Returns void

forEachObserver

forEachObserver(observerFunc: (observer: MessagingSessionObserver) => void): void

Implementation of MessagingSession.forEachObserver
- Defined in src/messagingsession/DefaultMessagingSession.ts:88
Iterates through each observer, so that their notification functions may be called.

Parameters
- observerFunc: (observer: MessagingSessionObserver) => void
  - - (observer: MessagingSessionObserver): void
    - Parameters
      - observer: MessagingSessionObserver
      Returns void
Returns void

removeObserver

removeObserver(observer: MessagingSessionObserver): void

Implementation of MessagingSession.removeObserver
- Defined in src/messagingsession/DefaultMessagingSession.ts:65
Remove an observer.

Parameters
- observer: MessagingSessionObserver
Returns void

start

start(): Promise<void>

Implementation of MessagingSession.start
- Defined in src/messagingsession/DefaultMessagingSession.ts:70
Start a messaging session. This promise is fulfilled when messaging session is established successfully. Promise is rejected when there are errors in communicating to messaging endpoint or connection is Unauthorized.

Returns Promise<void>

stop

stop(): void

Implementation of MessagingSession.stop
- Defined in src/messagingsession/DefaultMessagingSession.ts:78
Stop a messaging session.

Returns void

Generated using TypeDoc