Interface CadenzaClientOptions

interface CadenzaClientOptions {
    baseUrl?: string;
    debug?: boolean;
    iframe?: string | HTMLIFrameElement;
    skipGuest?: boolean;
    webApplication?: ExternalLinkKey;
}

Properties

baseUrl?: string

The base URL of the Cadenza server

debug?: boolean

Whether to enable debug logging; It can also be enabled/disabled at runtime via the devtools console:

localStorage.setItem('cadenzajs.debug', 'true'); // or 'false'

Then you need to reload the page.

iframe?: string | HTMLIFrameElement

An iframe for embedding Cadenza or the iframe's ID. The iframe is required only for methods that embed Cadenza in an iframe, so e.g. not for CadenzaClient#fetchData. If you want to embed Cadenza in multiple iframes, you need to create an instance of the CadenzaClient per iframe.

skipGuest?: boolean

Whether a configured guest authenticator should be ignored

webApplication?: ExternalLinkKey

An external link that Cadenza uses to resolve the target origin when posting events. This is required if Cadenza and your application are not running on the same origin. Please ensure that the user has view privilege for that link!