Class DefaultMessagingSession

Implements

MessagingSession

Index

Constructors

Methods

addObserver forEachObserver removeObserver start stop

Constructors

constructor

new DefaultMessagingSession(
    configuration: MessagingSessionConfiguration,
    logger: Logger,
    webSocket?: WebSocketAdapter,
    reconnectController?: ReconnectController,
    sigV4?: SigV4,
): DefaultMessagingSession
Parameters
- configuration: MessagingSessionConfiguration
- logger: Logger
- OptionalwebSocket: WebSocketAdapter
- OptionalreconnectController: ReconnectController
- OptionalsigV4: SigV4
Returns DefaultMessagingSession
- Defined in src/messagingsession/DefaultMessagingSession.ts:31

Methods

addObserver

addObserver(observer: MessagingSessionObserver): void
Add an observer.
Parameters
- observer: MessagingSessionObserver
Returns void
Implementation of MessagingSession.addObserver
- Defined in src/messagingsession/DefaultMessagingSession.ts:60

forEachObserver

forEachObserver(
observerFunc: (observer: MessagingSessionObserver) => void,
): void
Iterates through each observer, so that their notification functions may be called.
Parameters
- observerFunc: (observer: MessagingSessionObserver) => void
Returns void
Implementation of MessagingSession.forEachObserver
- Defined in src/messagingsession/DefaultMessagingSession.ts:88

removeObserver

removeObserver(observer: MessagingSessionObserver): void
Remove an observer.
Parameters
- observer: MessagingSessionObserver
Returns void
Implementation of MessagingSession.removeObserver
- Defined in src/messagingsession/DefaultMessagingSession.ts:65

start

start(): Promise<void>
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>
Implementation of MessagingSession.start
- Defined in src/messagingsession/DefaultMessagingSession.ts:70

stop

stop(): void
Stop a messaging session.

Returns void
Implementation of MessagingSession.stop
- Defined in src/messagingsession/DefaultMessagingSession.ts:78