Skip to main content

@enreachde/swyx-web-extension-sdk / Exports

SDK for Swyx Web Extensions

The package exposes typed APIs for call control, user presence, phonebook access, call journal access and server-pushed events.

Installation​

npm install @enreachde/swyx-web-extension-sdk

Requirements​

  • A compatible Swyx server
  • A compatible SwyxIt!

Compatibility​

The SDK major version is aligned to a SwyxIt! version.

SDK majorMinimum SwyxIt! version
115.00

Quickstart​

import {
CreateWebExtensionClient,
ConnectionEvent,
ConnectionReason,
ConsoleLogger,
} from '@enreachde/swyx-web-extension-sdk';

const client = CreateWebExtensionClient();
const { connection, hub, hubBack } = client;
const logger = new ConsoleLogger();

hubBack.onConnectionStateChanged((event: ConnectionEvent, reason: ConnectionReason) => {
logger.info('HubBack', 'onConnectionStateChanged', `Connection state changed: ${event}, ${reason}`);
});

await connection.Connect();

const user = await hub.GetLoggedInUser();
logger.info('Hub', 'GetLoggedInUser', `Logged in user: ${user.userName}`);

await connection.Disconnect(ConnectionReason.Shuttingdown, true);