Lime Web Components API Documentation - v7.4.0
    Preparing search index...

    Interface PlatformServiceNameType

    Interface for platform service names that gets augmented by each service module.

    Each platform service extends this interface through module augmentation to add its service name. This pattern provides compile-time type safety for service names.

    import { PlatformServiceName } from '@limetech/lime-web-components';

    // Stands in for the client type the real service module declares alongside this
    interface ExampleClient {
    fetch(id: string): Promise<unknown>;
    }

    const SERVICE_NAME = 'example';

    PlatformServiceName.ExampleService = SERVICE_NAME;

    declare module '@limetech/lime-web-components' {
    interface PlatformServiceNameType {
    ExampleService: typeof SERVICE_NAME;
    }

    interface LimeWebComponentPlatform {
    get(name: PlatformServiceNameType['ExampleService']): ExampleClient;
    }
    }
    interface PlatformServiceNameType {
        AIContextRegistry: "aiContextRegistry";
        Application: "state.application";
        CommandBus: "commandBus";
        ConditionRegistry: "conditionRegistry";
        ConfigRepository: "state.configs";
        ContextRegistry: "contextRegistry";
        DateTimeFormatter: "datetimeformatter";
        Device: "state.device";
        Dialog: "dialog";
        EventDispatcher: "eventDispatcher";
        FilterRepository: "state.filters";
        Http: "http";
        KeybindingRegistry: "keybindingRegistry";
        LimeFileRepository: "state.limefiles";
        LimeObjectRepository: "state.limeobjects";
        LimeTypeRepository: "state.limetypes";
        Logger: "logger";
        Navigator: "navigator";
        Notification: "notifications";
        NotificationRepository: "state.notifications";
        PollerFactory: "pollerFactory";
        ProblemRepository: "problemRepository";
        Query: "query";
        RouteRegistry: "routeRegistry";
        RuleRegistry: "ruleRegistry";
        TaskRepository: "state.tasks";
        Translate: "translate";
        UserDataRepository: "state.user-data";
        UserPreferencesRepository: "userPreferences";
        ViewFactoryRegistry: "viewFactoryRegistry";
        WebComponentRegistry: "webComponentRegistry";
    }
    Index

    Properties

    AIContextRegistry: "aiContextRegistry"
    Application: "state.application"
    CommandBus: "commandBus"
    ConditionRegistry: "conditionRegistry"

    Use RuleRegistry (service name 'ruleRegistry') instead. The legacy 'conditionRegistry' service stays registered during the deprecation window.

    ConfigRepository: "state.configs"
    ContextRegistry: "contextRegistry"
    DateTimeFormatter: "datetimeformatter"
    Device: "state.device"

    Device

    Dialog: "dialog"
    EventDispatcher: "eventDispatcher"
    FilterRepository: "state.filters"
    Http: "http"
    KeybindingRegistry: "keybindingRegistry"

    Work in progress, do not use!

    LimeFileRepository: "state.limefiles"
    LimeObjectRepository: "state.limeobjects"
    LimeTypeRepository: "state.limetypes"
    Logger: "logger"
    Navigator: "navigator"
    Notification: "notifications"
    NotificationRepository: "state.notifications"
    PollerFactory: "pollerFactory"
    ProblemRepository: "problemRepository"
    Query: "query"
    RouteRegistry: "routeRegistry"
    RuleRegistry: "ruleRegistry"
    TaskRepository: "state.tasks"
    Translate: "translate"
    UserDataRepository: "state.user-data"
    UserPreferencesRepository: "userPreferences"
    ViewFactoryRegistry: "viewFactoryRegistry"
    WebComponentRegistry: "webComponentRegistry"