Lime Web Components API Documentation - v5.1.0

This is the public API for Lime Web Components. It contains helper functions and interfaces for all services available in the Lime CRM platform.

Index

Command bus

CommandEventName CommandBus CommandHandler CommandMiddleware CommandOptions CallableCommandMiddleware CommandClass CommandEvent CommandEventDetail CommandIdentifier Command getCommandId

Query

Operator Expression Filter Query QueryResponse QueryService

Tasks

TaskEventType TaskState TaskRepository TaskStatus TaskEvent TaskEventDetail

Lime objects

BulkCreateDialogCommand CreateLimeobjectDialogCommand DeleteObjectCommand OpenObjectAccessDialogCommand SaveLimeObjectCommand AggregationGroups LimeObject LimeObjectRepository LoadOptions ObjectAggregation ObjectResponse PropertyOrder SaveLimeObjectError SelectLimeObjectsOptions SelectCurrentLimeObject SelectLimeObjects

Navigation

NavigateCommand Navigator SelectQueryParamOptions Blocker Location LocationChange NavigationEvent Retry Transition SelectQueryParam

Lime types

Acl LimeProperty LimeType Option SelectLimeTypesOptions PropertyType SelectCurrentLimeType SelectLimeTypes isDate isFloat isRelation isSingleRelation isString

Notifications

AlertOptions ConfirmOptions NotificationOptions Notifications ReportOptions

Interfaces

CommandConfig HttpResponseError ValidationError

Config

ConfigRepository SelectConfigOptions SelectConfig

Core

ContextAwareStateOptions LimePluginLoader LimeWebComponent LimeWebComponentContext LimeWebComponentPlatform PlatformServiceNameType StateDecoratorConfig StateOptions StateRepository PlatformServiceName

Device

Device DeviceType SelectDevice

Dialog

DialogRenderer DialogDestroyedEvent DialogListeners DialogProperties

Event dispatching

EventDispatcher

Filters

FilterRepository SelectFiltersOptions SelectFilters

HTTP

HttpClient HttpHeaders HttpOptions HttpParams HttpResponseType

Keyboard shortcuts

Keybinding KeybindingRegistry

Registering routes

RouteComponent RouteRegistry MatchedComponent

User data

SelectUserDataOptions UserDataRepository SelectUserData

Application

Session User UserCoworker UserGroup SelectApplicationName SelectCurrentUser SelectSession

Localization

Translator

Settings

Member Visibility

Theme