Config: {
    idleShutdownGraceTimeout?: number;
    idleTimeout?: number;
    logLevel?: LogLevel;
    reconnectionTimeout?: number;
}

Optional configurations for the client

Type declaration

  • Optional idleShutdownGraceTimeout?: number

    Time period (in seconds) before an 'IDLE' user session will be terminated due to continued inactivity. The timer is stopped if an activity is triggered from the user session. See idleTimeout for more details. On expiry of this timeout, the SDK instance is shutdown (equivalent of calling AvayaCCaaSChatSDK.shutdown) and EventType.SHUTDOWN event is generated. AvayaCCaaSChatSDK.init will need to be called to re-initialize the SDK

    Minimum allowed value : 30 Seconds

    Maximum allowed value : 300 Seconds

    Default Value

    30

  • Optional idleTimeout?: number

    Time period (in seconds) before user session is considered as idle due to no activity. A request to AvayaCCaaSChatSDK.createEngagement, Engagement.join, Engagement.disconnect, Engagement.sendMessage or AvayaCCaaSChatSDK.resetIdleTimeout is considered as an activity from user. The idleTimeout is reset after any of these activities are triggered. Once the idleTimeout expires, EventType.IDLE_TIMEOUT_EXPIRED event is generated and idleShutdownGraceTimeout is started

    Minimum allowed value : 300 Seconds

    Maximum allowed value : 3300 Seconds

    Setting the value to '0' disables the idleTimeout feature

    Default Value

    900

  • Optional logLevel?: LogLevel

    Log Level.

    Default Value

    ERROR

  • Optional reconnectionTimeout?: number

    Maximum time (in seconds) allowed for reconnection after SDK is disconnected from the server due to connection errors.

    Minimum allowed value : 120 Seconds

    Maximum allowed value : 900 Seconds

    Default Value

    300