Skip to main content

@enreachde/swyx-web-extension-sdk - v1.0.1 / Exports / IWebExtensionHubBack

Interface: IWebExtensionHubBack

Back-channel event interface for server-pushed WebExtension notifications.

Table of contents​

ConnectionStateChanged​

LanguageChanged​

LineDetailsChanged​

LineKeyConfigChanged​

LineSelectionChanged​

LineStateChanged​

NotificationCallsChanged​

NumberOfLinesChanged​

PhonebookReloaded​

UserPhoneCallListChanged​

UserPhoneCallbackListChanged​

UserPresenceChanged​

UserRedialListChanged​

ConnectionStateChanged​

offAllConnectionStateChanged​

▸ offAllConnectionStateChanged(): void

Removes all connection state change subscription callbacks.

Returns​

void


offConnectionStateChanged​

▸ offConnectionStateChanged(callback): void

Removes a connection state change subscription callback.

Parameters​

NameType
callback(event: ConnectionEvent, reason: ConnectionReason) => void

Returns​

void


onConnectionStateChanged​

▸ onConnectionStateChanged(callback): void

Subscribes to low-level connection state changes from the connector.

Parameters​

NameType
callback(event: ConnectionEvent, reason: ConnectionReason) => void

Returns​

void

LanguageChanged​

offAllLanguageChanged​

▸ offAllLanguageChanged(): void

Removes all language change subscription callbacks.

Returns​

void


offLanguageChanged​

▸ offLanguageChanged(callback): void

Removes a language change subscription callback.

Parameters​

NameType
callback(language: string) => void

Returns​

void


onLanguageChanged​

▸ onLanguageChanged(callback): void

Subscribes to language change notifications.

Parameters​

NameType
callback(language: string) => void

Returns​

void

LineDetailsChanged​

offAllLineDetailsChanged​

▸ offAllLineDetailsChanged(): void

Removes all line details change subscription callbacks.

Returns​

void


offLineDetailsChanged​

▸ offLineDetailsChanged(callback): void

Removes a line details change subscription callback.

Parameters​

NameType
callback(lineDetails: LineDetails) => void

Returns​

void


onLineDetailsChanged​

▸ onLineDetailsChanged(callback): void

Subscribes to line details change notifications.

Parameters​

NameType
callback(lineDetails: LineDetails) => void

Returns​

void

LineKeyConfigChanged​

offAllLineKeyConfigChanged​

▸ offAllLineKeyConfigChanged(): void

Removes all line key configuration change subscription callbacks.

Returns​

void


offLineKeyConfigChanged​

▸ offLineKeyConfigChanged(callback): void

Removes a line key configuration change subscription callback.

Parameters​

NameType
callback() => void

Returns​

void


onLineKeyConfigChanged​

▸ onLineKeyConfigChanged(callback): void

Subscribes to line key configuration change notifications.

Parameters​

NameType
callback() => void

Returns​

void

LineSelectionChanged​

offAllLineSelectionChanged​

▸ offAllLineSelectionChanged(): void

Removes all line selection change subscription callbacks.

Returns​

void


offLineSelectionChanged​

▸ offLineSelectionChanged(callback): void

Removes a line selection change subscription callback.

Parameters​

NameType
callback(lineIndex: number) => void

Returns​

void


onLineSelectionChanged​

▸ onLineSelectionChanged(callback): void

Subscribes to line selection change notifications.

Parameters​

NameType
callback(lineIndex: number) => void

Returns​

void

LineStateChanged​

offAllLineStateChanged​

▸ offAllLineStateChanged(): void

Removes all line state change subscription callbacks.

Returns​

void


offLineStateChanged​

▸ offLineStateChanged(callback): void

Removes a line state change subscription callback.

Parameters​

NameType
callback(lineIndex: number, lineState: LineState) => void

Returns​

void


onLineStateChanged​

▸ onLineStateChanged(callback): void

Subscribes to line state change notifications.

Parameters​

NameType
callback(lineIndex: number, lineState: LineState) => void

Returns​

void

NotificationCallsChanged​

offAllNotificationCallsChanged​

▸ offAllNotificationCallsChanged(): void

Removes all notification call list subscription callbacks.

Returns​

void


offNotificationCallsChanged​

▸ offNotificationCallsChanged(callback): void

Removes a notification call list subscription callback.

Parameters​

NameType
callback(notificationCallDetails: NotificationCallDetails[]) => void

Returns​

void


onNotificationCallsChanged​

▸ onNotificationCallsChanged(callback): void

Subscribes to notification call list updates.

Parameters​

NameType
callback(notificationCallDetails: NotificationCallDetails[]) => void

Returns​

void

NumberOfLinesChanged​

offAllNumberOfLinesChanged​

▸ offAllNumberOfLinesChanged(): void

Removes all number-of-lines change subscription callbacks.

Returns​

void


offNumberOfLinesChanged​

▸ offNumberOfLinesChanged(callback): void

Removes a number-of-lines change subscription callback.

Parameters​

NameType
callback(numberOfLines: number) => void

Returns​

void


onNumberOfLinesChanged​

▸ onNumberOfLinesChanged(callback): void

Subscribes to number-of-lines change notifications.

Parameters​

NameType
callback(numberOfLines: number) => void

Returns​

void

PhonebookReloaded​

offAllPhonebookReloaded​

▸ offAllPhonebookReloaded(): void

Removes all phonebook reload subscription callbacks.

Returns​

void


offPhonebookReloaded​

▸ offPhonebookReloaded(callback): void

Removes a phonebook reload subscription callback.

Parameters​

NameType
callback() => void

Returns​

void


onPhonebookReloaded​

▸ onPhonebookReloaded(callback): void

Subscribes to phonebook reload notifications.

Parameters​

NameType
callback() => void

Returns​

void

UserPhoneCallListChanged​

offAllUserPhoneCallListChanged​

▸ offAllUserPhoneCallListChanged(): void

Removes all user phone call list change subscription callbacks.

Returns​

void


offUserPhoneCallListChanged​

▸ offUserPhoneCallListChanged(callback): void

Removes a user phone call list change subscription callback.

Parameters​

NameType
callback() => void

Returns​

void


onUserPhoneCallListChanged​

▸ onUserPhoneCallListChanged(callback): void

Subscribes to user phone call list change notifications.

Parameters​

NameType
callback() => void

Returns​

void

UserPhoneCallbackListChanged​

offAllUserPhoneCallbackListChanged​

▸ offAllUserPhoneCallbackListChanged(): void

Removes all user phone callback list change subscription callbacks.

Returns​

void


offUserPhoneCallbackListChanged​

▸ offUserPhoneCallbackListChanged(callback): void

Removes a user phone callback list change subscription callback.

Parameters​

NameType
callback() => void

Returns​

void


onUserPhoneCallbackListChanged​

▸ onUserPhoneCallbackListChanged(callback): void

Subscribes to user phone callback list change notifications.

Parameters​

NameType
callback() => void

Returns​

void

UserPresenceChanged​

offAllUserPresenceChanged​

▸ offAllUserPresenceChanged(): void

Removes all user presence change subscription callbacks.

Returns​

void


offUserPresenceChanged​

▸ offUserPresenceChanged(callback): void

Removes a user presence change subscription callback.

Parameters​

NameType
callback(userPresence: UserPresence) => void

Returns​

void


onUserPresenceChanged​

▸ onUserPresenceChanged(callback): void

Subscribes to user presence change notifications.

Parameters​

NameType
callback(userPresence: UserPresence) => void

Returns​

void

UserRedialListChanged​

offAllUserRedialListChanged​

▸ offAllUserRedialListChanged(): void

Removes all user redial list change subscription callbacks.

Returns​

void


offUserRedialListChanged​

▸ offUserRedialListChanged(callback): void

Removes a user redial list change subscription callback.

Parameters​

NameType
callback() => void

Returns​

void


onUserRedialListChanged​

▸ onUserRedialListChanged(callback): void

Subscribes to user redial list change notifications.

Parameters​

NameType
callback() => void

Returns​

void