API

The LogUI Client API

How do you interact with the LogUI client library programmatically? How do you integrate the LogUI client into your application's codebase? In order to answer these questions, we've created this short page to provide you with information on the functionality offered by the public-facing LogUI client library API.

When loaded correctly, the LogUI client will always be available at the LogUI object — or, to be more precise, window.LogUI. Using your browser's console, you can interact and play with the API to get an understanding of what each of the exposed functions does, and complement that with reading the descriptions offered below.

Note that the config object

Exposed Properties and Functions

Find the header for the property/function you are interested in below.

buildDate

buildEnvironment

buildVersion

clearSessionID()

deleteApplicationSpecificDataKey()

init(configObject)

isActive()

logCustomMessage(objectToLog)

stop()

updateApplicationSpecificData()

Considerations when Integrating the LogUI Client