@avaya/infinity-agent-sdk - v1.0.0
    Preparing search index...

    Interface AvayaInfinityAgentSdkInitParams

    Configuration parameters for initializing the Avaya Infinity Agent SDK.

    interface AvayaInfinityAgentSdkInitParams {
        avayaInfinityHost: string;
        clientId: string;
        oAuthRedirectUri: string;
        oAuthMode?: OAuthMode;
        idpHint?: string;
        logLevel?: LogLevel;
        logBufferCapacity?: number;
    }
    Index

    Properties

    avayaInfinityHost: string

    The Avaya Infinity host URL (e.g., "api.avayacloud.com" or "https://api.avayacloud.com")

    clientId: string

    OAuth client ID for authentication

    oAuthRedirectUri: string

    The OAuth redirect URI for the authentication callback. Must exactly match one of the allowed redirect URIs configured for your client ID in the Avaya Infinity admin UI under SDK Provisioning.

    • In redirect mode: typically the URL of the page that calls init() (e.g. window.location.origin).
    • In popup mode: the URL where the callback page is hosted (e.g. "https://your-app.com/callback.html"). See oAuthMode for callback page options.
    oAuthMode?: OAuthMode

    OAuth flow mode. Defaults to 'redirect'.

    • 'redirect' - Navigates the current page to the IdP login page. After authentication, the platform redirects back to oAuthRedirectUri and init() must be called again to complete the flow. Best for standalone SPAs.

    • 'popup' - Opens the IdP login page in a popup window. The current page is never navigated away, and init() resolves once the popup completes authentication. Best for embedded environments (e.g., Salesforce iframes) or when init() should only be called once. Must be invoked within a user click handler to avoid popup blockers. Requires a callback page hosted at oAuthRedirectUri to forward the authorization code back to the SDK. Use the SDK-provided callback.html or a custom page that calls the exported AvayaInfinityAgentSdk.handleOAuthCallback helper.

    idpHint?: string

    Identity Provider hint. When set, the login/IdP-selection screen is skipped and the agent is sent directly to the specified identity provider.

    The value is the IdP alias configured for your tenant; obtain it from your Avaya administrator. Omit to use the default login flow.

    logLevel?: LogLevel

    Optional log level for SDK logging. Defaults to LogLevel.INFO if not specified

    logBufferCapacity?: number

    Optional initial capacity (number of entries) for the in-memory log buffer exported by AvayaInfinityAgentSdk.exportLogs.

    Defaults to 2000 when omitted. The value is truncated to an integer and clamped to the range [100, 5000]; an out-of-range or non-integer value is adjusted (with a console warning) rather than rejected - init() never throws because of this field. Equivalent to calling AvayaInfinityAgentSdk.setLogBufferCapacity immediately after init.