Avaya Infinity Omni SDK
    Preparing search index...

    Type Alias InitParams

    Parameters to initialize the Omni SDK and create a session for this Omni SDK instance on the server.

    type InitParams = {
        displayName?: string;
        host: string;
        idleShutdownGraceTimeoutDuration?: number;
        idleTimeoutDuration?: number;
        integrationId: string;
        jwtProvider: JwtProvider;
        logLevel?: LogLevel;
        sessionParameters?: Record<string, string>;
        token: string;
    }
    Index

    Properties

    displayName? host idleShutdownGraceTimeoutDuration? idleTimeoutDuration? integrationId jwtProvider logLevel? sessionParameters? token

    Properties

    displayName?: string

    Name of the user which is presented to others.

    host: string

    Hostname of the Avaya Infinity API endpoint to connect to.

    idleShutdownGraceTimeoutDuration?: number

    The maximum time (in milliseconds) a User can still remain inactive after the idle timeout before the Omni SDK automatically shuts down.

    idleTimeoutDuration?: number

    The maximum time (in milliseconds) a user can be inactive before the grace timer starts.

    integrationId: string

    The unique web chat integration id configured in Avaya Infinity admin console.

    jwtProvider: JwtProvider

    Implementation of the JwtProvider interface provided by the application to handle the JWT lifecycle events and renew the JWT for the Omni SDK by communicating with their own backend application server.

    logLevel?: LogLevel

    Logging level of the Omni SDK. If not specified LogLevel.WARN will be used by default.

    sessionParameters?: Record<string, string>

    The key value pairs capturing additional context information about this session of the User.

    token: string

    Initial JWT to initialize the Omni SDK.

    Settings

    On This Page

    Properties