Configuration

get()

The Configuration API exposes data related to the event, the plugin, the environment, etc. It can be very useful when you want to adapt behaviors according to those information.

usage:

import { Configuration } from '@livestorm/plugin'

const locale = Configuration.get('locale')

// Do something based on the locale

Exposed keys

Environment

Key

Type

Description

locale

string

The current locale of the app. e.g.: fr, en, es, it

organizationId

string

The ID of the organization

origin

string

The origin of the current URL

queryString

object

The query params of the current URL

Event

Key

Type

Description

eventTypeId

string

The ID of the type of the event

isPublished

boolean

Whether the event is published or not

sessionId

string

The ID of the session

Plugin

Key

Type

Description

pluginHost

string

The host of the plugin server

pluginId

string

The ID of the plugin

pluginName

string

The name of the plugin


Did this page help you?