Lime Web Components API Documentation - v6.24.0
    Preparing search index...

    Lime Web Components API Documentation - v6.24.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.

    Everything that is exported from this package is marked with one of the following statuses

    • @public - Released and ready to be used. The interface is stable and should not have any breaking changes without triggering a new major release.
    • @beta - The interface is fairly stable and can be used by those willing to accept breaking changes without notice. Breaking changes may still happen without notice, and without triggering a new major release. Feedback on the interfaces are welcome.
    • @alpha - Still under development and is likely to have frequent breaking changes without notice.
    • @deprecated - Can be used for the time being, but will be removed in the future. Has likely been replaced by something better. Do not use when writing new code.
    • @internal - Do not use!

    Interfaces

    UserPreferencesRepository
    ValidationError

    Type Aliases

    JsonValue
    NotificationType

    AI Context

    AIContextContribution
    AIContextProvider
    AIContextRegistry
    GatheredAIContext

    Actions

    Action
    LimeObjectAction
    LimeObjectBulkAction

    Application

    ApplicationRepository
    Session
    User
    UserCoworker
    UserGroup
    SelectApplicationName
    SelectCurrentUser
    SelectSession

    Command bus

    CommandEventName
    AnyCommand
    CommandBus
    CommandConfig
    CommandHandler
    CommandMiddleware
    CommandOptions
    CommandRegistry
    LimeObjectBulkCommand
    LimeObjectCommand
    CallableCommandMiddleware
    CommandClass
    CommandEvent
    CommandEventDetail
    CommandIdentifier
    CommandMetadata
    Command
    getCommandId
    getCommandIds

    Conditions

    ConditionRegistry
    ActionCondition
    Condition
    ConditionMetadata
    ConditionType
    LimeObjectCondition
    isActionCondition
    isLimeObjectCondition

    Config

    ConfigRepository
    SelectConfigOptions
    SelectConfig

    Context

    ContextMap
    ContextMetadata
    ContextProviderHandle
    ContextRegistry
    ContextScope
    ContextScopeOptions
    ProvideContext
    SelectContext

    Core

    ComponentDescriptor
    ContextAwareStateOptions
    FeatureSwitches
    LimePackageMetadata
    LimePluginLoader
    LimeWebComponent
    LimeWebComponentContext
    LimeWebComponentPlatform
    PlatformServiceNameType
    StateDecoratorConfig
    StateOptions
    StateRepository
    ConfigMetadata
    Icon
    IdleState
    IdleStateChangeEvent
    IdleStateEventName
    PlatformServiceName

    Device

    Device
    DeviceType
    SelectDevice

    Dialog

    DialogRenderer
    DialogDestroyedEvent
    DialogListeners
    DialogProperties

    Event dispatching

    EventDispatcher

    Filters

    FilterRepository
    SelectFiltersOptions
    SelectFilters

    HTTP

    HttpClient
    HttpHeaders
    HttpOptions
    HttpParams
    HttpResponseError
    HttpMethod
    HttpResponseType
    HttpMethod

    Keyboard shortcuts

    Keybinding
    KeybindingRegistry

    Lime objects

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

    Lime types

    Acl
    LimeProperty
    LimeType
    LimeTypeRepository
    Option
    SelectLimeTypesOptions
    DateTimePropertyType
    PropertyType
    findLimetypeByLabel
    getPropertiesByType
    getPropertyByLabel
    getPropertyByName
    hasLabel
    isDate
    isFloat
    isRelation
    isSingleRelation
    isString
    SelectCurrentLimeType
    SelectLimeTypes

    Localization

    DateTimeFormatter
    DateTimeFormatterOptions
    Translator
    DateTimeType
    HourCycle

    Logger

    Logger
    LoggerFactory
    LogHandler
    LogStore
    LogData
    LogEntry
    LogLevel
    LogLevel
    createLogger
    getPackageNameFromUrl

    Navigation

    SelectQueryParamOptions
    Blocker
    Location
    LocationChange
    Retry
    Transition
    SelectQueryParam

    NotificationRepository

    NotificationLoadOptions
    NotificationRepository
    Notification
    NotificationCount
    NotificationResponse

    Notifications

    AlertOptions
    ConfirmOptions
    NotificationOptions
    Notifications
    ReportOptions

    Poller

    Poller
    PollerFactory

    Problem

    Problem
    ProblemError
    ProblemProvider
    ProblemQueryOptions
    ProblemRepository
    ProblemStatus
    ProblemType
    ProblemView
    ProblemContext
    ProblemContextFilter
    ProblemSeverity
    ProblemSeverity

    Query

    Operator
    Filter
    Query
    QueryResponse
    QueryService
    AggregateOperator
    AndOrExpression
    BasicExpression
    BasicOperator
    Expression
    ExpressionValue
    InExpression
    InFilterExpression
    NotExpression
    AggregateOperator

    Registering routes

    RouteComponent
    RouteRegistry
    MatchedComponent

    Rules

    RuleAll
    RuleAny
    RuleNot
    RulePrimitive
    RuleRef
    RuleRegistry
    RuleValidationFailure
    RuleValidationIssue
    RuleValidationSuccess
    StoredRule
    CompiledRule
    PrimitiveMetadata
    Rule
    RuleValidationResult
    definePrimitive

    Tasks

    TaskEventType
    TaskState
    TaskRepository
    TaskStatus
    TaskEvent
    TaskEventDetail

    User data

    SelectUserDataOptions
    UserDataRepository
    SelectUserData

    Views

    ViewFactoryRegistry
    ViewLayoutConfigurationComponent
    ViewFactory
    ViewLayout

    Web components

    WebComponentRegistry
    WebComponentMetadata