Converge Sdk Configuration

Properties

activity?

optional activity: ActivitySdkConfiguration

debug?

optional debug: object = {}

isDiagnosisEnabled?

optional isDiagnosisEnabled: boolean

Toggles diagnosis logging

Default

false

isEnabled?

optional isEnabled: boolean

Toggles debug logging to browser console

Default

false

isGlobalErrorListeningEnabled?

optional isGlobalErrorListeningEnabled: boolean

Toggles global listening to JavaScript errors that occur in the app

Default

information

isLogPublishingDisabled?

optional isLogPublishingDisabled: boolean

Toggles publishing SDK logs to Seeka backend for diagnosis and reporting from within the Seeka application.

Default

false

isToStringLogEnabled?

optional isToStringLogEnabled: boolean

Toggles .toString() call on all logged objects to console.
Useful when using the browser 'Preserve log' option in console to persist logged object across page reloads.

Default

false

Deprecated

Use Sidekick diagnose mode instead

minimumLevel?

optional minimumLevel: SdkLogEventLevel

Minimum level of logs that will be outputted to the console

Default

information

enablement?

optional enablement: OrganisationBrandBillingStatusEnablement

endpoint

endpoint: string = ""

Seeka API endpoint

Default Value

https://api.seeka.services

handlers?

optional handlers: HandlersSdkConfiguration

Handlers to initialise
View plugin list

ingestEndpoint

ingestEndpoint: string = ""

Seeka Ingest endpoint

Default Value

https://router.seeka.services

isDisabled

isDisabled: boolean = false

Toggles disabling or enabling of the SDK.
If disabled, all calls to the tracking and identity SDKs will not be handled.

Default Value

false

key

key: string = ""

Converge public SDK key

organisationId

organisationId: string = ""

Seeka organisation ID

plugins?

optional plugins: IConvergePlugin<object>[] = []

Plugins to initialise
View plugin list

runtime

runtime: SeekaSdkRuntimeInfo = {}

scopeDescription

scopeDescription: string

The description to reference the installation. Used as a human readable reference when for this instance of the SDK. This is usually the brand name.

Example

"Super awesome brand"

scopeKey

scopeKey: string

The key to reference the installation. Used as a reference when calling methods for this instance of the SDK in Converge['3323ba69b19e4261a3fbd3f5d998f118'] calls. This is usually the Converge instance ID.

Example

"3323ba69b19e4261a3fbd3f5d998f118"

tracking

tracking: ConvergeEmbedTrackingWebsiteConfiguration = {}

Methods

ensureDefaults()

static ensureDefaults(config): void

Parameters

• config: ConvergeSdkConfiguration

Returns

void