Interface CCPluginConfig

Configuration options for the Contact Center Plugin. CCPluginConfig

Example

const config: CCPluginConfig = {
  allowMultiLogin: true,
  allowAutomatedRelogin: false,
  clientType: 'browser',
  isKeepAliveEnabled: true,
  force: false,
  metrics: { clientName: 'myClient', clientType: 'browser' },
  logging: { enable: true, verboseEvents: false },
  callingClientConfig: { ... }
};
interface CCPluginConfig {
    allowAutomatedRelogin: boolean;
    allowMultiLogin: boolean;
    callingClientConfig: CallingClientConfig;
    clientType: string;
    force: boolean;
    isKeepAliveEnabled: boolean;
    logging: {
        enable: boolean;
        verboseEvents: boolean;
    };
    metrics: {
        clientName: string;
        clientType: string;
    };
}

Properties

allowAutomatedRelogin allowMultiLogin callingClientConfig clientType force isKeepAliveEnabled logging metrics

Properties

allowAutomatedRelogin

allowAutomatedRelogin: boolean

Whether to automatically attempt relogin on connection loss

allowMultiLogin

allowMultiLogin: boolean

Whether to allow multiple logins from different devices

callingClientConfig

callingClientConfig: CallingClientConfig

Configuration for the calling client

clientType

clientType: string

The type of client making the connection

force

force: boolean

Whether to force registration

isKeepAliveEnabled

isKeepAliveEnabled: boolean

Whether to enable keep-alive messages

logging

logging: {
    enable: boolean;
    verboseEvents: boolean;
}

Logging configuration

Type declaration

  • enable: boolean

    Whether to enable logging

  • verboseEvents: boolean

    Whether to log verbose events

metrics

metrics: {
    clientName: string;
    clientType: string;
}

Metrics configuration

Type declaration

  • clientName: string

    Name of the client for metrics

  • clientType: string

    Type of client for metrics

Settings

Member Visibility

Theme

On This Page

allowAutomatedReloginallowMultiLogincallingClientConfigclientTypeforceisKeepAliveEnabledloggingmetrics