Interface SDKOptions

interface SDKOptions {
    apiURL?: string;
    appKey: string;
    baseURL?: string;
    build?: string;
    deviceName?: string;
    enableLogcatLogging?: boolean;
    logBrowserEvents?: boolean;
    logUIEvents?: boolean;
    maximumLocalStorageSize?: number;
    overrideConsoleMethods?: boolean;
    printToConsole?: boolean;
    registerErrorHandler?: boolean;
    version?: string;
}

Properties

apiURL? appKey baseURL? build? deviceName? enableLogcatLogging? logBrowserEvents? logUIEvents? maximumLocalStorageSize? overrideConsoleMethods? printToConsole? registerErrorHandler? version?

Properties

Optional apiURL

apiURL?: string

Base URL to Bugfender API

appKey

appKey: string

The app key to log into

Optional baseURL

baseURL?: string

Base URL to Bugfender web dashboard

Optional build

build?: string

App build identifier

Optional deviceName

deviceName?: string

Device name, this will be shown on the dashboard devices list. Defaults to browser + OS.

Optional enableLogcatLogging

enableLogcatLogging?: boolean

Logs all logs written via Logcat. Defaults to false. Android only.

Optional logBrowserEvents

logBrowserEvents?: boolean

Register a handler for most common browser events to report them to Bugfender. Defaults to true.

Optional logUIEvents

logUIEvents?: boolean

Register a handler for most common UI events to report them to Bugfender. Defaults to true.

Optional maximumLocalStorageSize

maximumLocalStorageSize?: number

Set the maximum size to store local log files in bytes. Range accepted is from 1MB to 50MB. Defaults to 5MB. iOS & Android only.

Optional overrideConsoleMethods

overrideConsoleMethods?: boolean

Override default window.console so it also logs to Bugfender. Defaults to true.

Optional printToConsole

printToConsole?: boolean

Print also with window.console when Bugfender logging methods are called. Defaults to true.

Optional registerErrorHandler

registerErrorHandler?: boolean

Register error handler for uncaught errors that reports a crash to Bugfender. Defaults to true.

Optional version

version?: string

App version identifier

Settings

Member Visibility

Theme

On This Page

apiURLappKeybaseURLbuilddeviceNameenableLogcatLogginglogBrowserEventslogUIEventsmaximumLocalStorageSizeoverrideConsoleMethodsprintToConsoleregisterErrorHandlerversion