Interface MessagingSession

interface MessagingSession {
    addObserver(observer: MessagingSessionObserver): void;
    forEachObserver(
        observerFunc: (observer: MessagingSessionObserver) => void,
    ): void;
    removeObserver(observer: MessagingSessionObserver): void;
    start(): Promise<void>;
    stop(): void;
}

Implemented by

DefaultMessagingSession

Index

Methods

addObserver forEachObserver removeObserver start stop

Methods

addObserver

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

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
- Defined in src/messagingsession/MessagingSession.ts:32

removeObserver

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

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>
- Defined in src/messagingsession/MessagingSession.ts:11

stop

stop(): void
Stop a messaging session.

Returns void
- Defined in src/messagingsession/MessagingSession.ts:16