Interface IConfigurationService

Application configuration

Hierarchy

IEventEmitter<ConfigurationEventType>
- IConfigurationService

Index

Properties

Methods

Properties

reviewMode

reviewMode: ReviewMode

The review mode of the coding card

workspaceId

workspaceId: number

Application Workspace ID

Methods

off

off(eventType: ConfigurationEventType, handler?: EventHandler, once?: boolean): void

Inherited from IEventEmitter.off
Unregisters an event handler

Parameters
- eventType: ConfigurationEventType
  
  Event to unregister from
- Optional handler: EventHandler
  
  Event handler function. If not passed in, it removes all event handlers.
- Optional once: boolean
  
  Boolean indicating if the event handler was registered as a one-time event handler (Defaults to false)
Returns void

on

on(eventType: ConfigurationEventType, handler: EventHandler): void

Inherited from IEventEmitter.on
Registers an event handler

Parameters
- eventType: ConfigurationEventType
  
  Event to listen for
- handler: EventHandler
  
  Event handler function
Returns void

once

once(eventType: ConfigurationEventType, handler: EventHandler): void

Inherited from IEventEmitter.once
Registers an event handler that is only run once

Parameters
- eventType: ConfigurationEventType
  
  Event to listen for
- handler: EventHandler
  
  Event handler function
Returns void

updateSetting

updateSetting(settingName: ConfigurationSettingName, value: any): any

Updates the specified configuration setting to the value passed in

Parameters
- settingName: ConfigurationSettingName
- value: any
Returns any

Send comments on this topic to Relativity documentation