Interface LimeWebComponentPlatform

Service container for the Lime CRM platform

Hierarchy

LimeWebComponentPlatform

Index

Properties

type

Methods

get has isFeatureEnabled? register

Properties

type

type: "LimeCRMWebClient" | "LimeCRMDesktopClient" | "LimeCRMWebAdminClient"

Methods

get

get(name: string): any
Get a service
Parameters
- name: string
  
  the name of the service
Returns any
get(name: "webComponentRegistry"): WebComponentRegistry
Parameters
- name: "webComponentRegistry"
Returns WebComponentRegistry
get(name: "eventDispatcher"): EventDispatcher
Parameters
- name: "eventDispatcher"
Returns EventDispatcher
get(name: "query"): QueryService
Parameters
- name: "query"
Returns QueryService
get(name: "state.limetypes"): LimeTypeRepository
Parameters
- name: "state.limetypes"
Returns LimeTypeRepository
get(name: "state.limeobjects"): LimeObjectRepository
Parameters
- name: "state.limeobjects"
Returns LimeObjectRepository
get(name: "commandBus"): CommandBus
Parameters
- name: "commandBus"
Returns CommandBus
get(name: "conditionRegistry"): ConditionRegistry
Parameters
- name: "conditionRegistry"
Returns ConditionRegistry
get(name: "translate"): Translator
Parameters
- name: "translate"
Returns Translator
get(name: "http"): HttpClient
Parameters
- name: "http"
Returns HttpClient
get(name: "dialog"): DialogRenderer
Parameters
- name: "dialog"
Returns DialogRenderer
get(name: "keybindingRegistry"): KeybindingRegistry
Parameters
- name: "keybindingRegistry"
Returns KeybindingRegistry
get(name: "routeRegistry"): RouteRegistry
Parameters
- name: "routeRegistry"
Returns RouteRegistry
get(name: "navigator"): Navigator
Parameters
- name: "navigator"
Returns Navigator
get(name: "notifications"): Notifications
Parameters
- name: "notifications"
Returns Notifications
get(name: "state.tasks"): TaskRepository
Parameters
- name: "state.tasks"
Returns TaskRepository
get(name: "state.configs"): ConfigRepository
Parameters
- name: "state.configs"
Returns ConfigRepository
get(name: "state.device"): Device
Parameters
- name: "state.device"
Returns Device
get(name: "state.filters"): FilterRepository
Parameters
- name: "state.filters"
Returns FilterRepository
get(name: "state.user-data"): UserDataRepository
Parameters
- name: "state.user-data"
Returns UserDataRepository
get(name: "state.application"): ApplicationRepository
Parameters
- name: "state.application"
Returns ApplicationRepository
get(name: "userPreferences"): UserPreferencesRepository
Parameters
- name: "userPreferences"
Returns UserPreferencesRepository
get(name: "datetimeformatter"): DateTimeFormatter
Parameters
- name: "datetimeformatter"
Returns DateTimeFormatter
get(name: "viewFactoryRegistry"): ViewFactoryRegistry
Alpha
Parameters
- name: "viewFactoryRegistry"
Returns ViewFactoryRegistry
get(name: "state.notifications"): NotificationRepository
Parameters
- name: "state.notifications"
Returns NotificationRepository
get(name: "pollerFactory"): PollerFactory
Parameters
- name: "pollerFactory"
Returns PollerFactory

has

has(name: string): boolean
Check if a service is currently registered on the platform
Parameters
- name: string
  
  the name of the service
Returns boolean

`Optional` isFeatureEnabled

isFeatureEnabled(name: never): boolean
Beta
Check if a feature is enabled
Parameters
- name: never
  
  name of the feature switch
Returns boolean

register

register(name: string, service: any): void
Register a service on the platform

Core platform service names are defined by the enum PlatformServiceName. Third parties that wants to register a service should add a prefix to the service name, e.g. the plugin name.
Parameters
- name: string
  
  the name of the service
- service: any
  
  the service
Returns void

Interface LimeWebComponentPlatform

Hierarchy

Index

Properties

Methods

Properties

type

Methods

get

Parameters

name: string

Returns any

Parameters

name: "webComponentRegistry"

Returns WebComponentRegistry

Parameters

name: "eventDispatcher"

Returns EventDispatcher

Parameters

name: "query"

Returns QueryService

Parameters

name: "state.limetypes"

Returns LimeTypeRepository

Parameters

name: "state.limeobjects"

Returns LimeObjectRepository

Parameters

name: "commandBus"

Returns CommandBus

Parameters

name: "conditionRegistry"

Returns ConditionRegistry

Parameters

name: "translate"

Returns Translator

Parameters

name: "http"

Returns HttpClient

Parameters

name: "dialog"

Returns DialogRenderer

Parameters

name: "keybindingRegistry"

Returns KeybindingRegistry

Parameters

name: "routeRegistry"

Returns RouteRegistry

Parameters

name: "navigator"

Returns Navigator

Parameters

name: "notifications"

Returns Notifications

Parameters

name: "state.tasks"

Returns TaskRepository

Parameters

name: "state.configs"

Returns ConfigRepository

Parameters

name: "state.device"

Returns Device

Parameters

name: "state.filters"

Returns FilterRepository

Parameters

name: "state.user-data"

Returns UserDataRepository

Parameters

name: "state.application"

Returns ApplicationRepository

Parameters

name: "userPreferences"

Returns UserPreferencesRepository

Parameters

name: "datetimeformatter"

Returns DateTimeFormatter

Parameters

name: "viewFactoryRegistry"

`Optional` isFeatureEnabled