graphdb-workbench/dist/api/services/app-lifecycle/application-lifecycle-context.service.d.ts

The web application for GraphDB APIs

import { ContextService } from '../context';
import { DeriveContextServiceContract } from '../../models/context/update-context-method';
import { ValueChangeCallback } from '../../models/context/value-change-callback';
import { LifecycleState } from '../../models/app-lifecycle';
type LifecycleDataContextFields = {
    readonly APPLICATION_DATA_STATE: string;
};
type LifecycleDataContextFieldParams = {
    readonly APPLICATION_DATA_STATE: LifecycleState;
};
/**
 * Service responsible for emitting and subscribing to application lifecycle events.
 * This service provides a centralized way to track and respond to key moments in the
 * application's lifecycle, such as when data is loaded
 */
export declare class ApplicationLifecycleContextService extends ContextService<LifecycleDataContextFields> implements DeriveContextServiceContract<LifecycleDataContextFields, LifecycleDataContextFieldParams> {
    readonly APPLICATION_DATA_STATE = "applicationDataLoaded";
    /**
     * Updates the application data state in the context.
     *
     * @param state - The lifecycle state to set for the application data
     * @returns void
     */
    updateApplicationDataState(state: LifecycleState): void;
    /**
     * Registers a callback function to be invoked when the application data state changes.
     *
     * @param callbackFn - The function to be called when the application data state changes.
     *                     The function will receive the new state value as its parameter.
     * @returns A function that, when called, will unsubscribe the callback from further notifications
     */
    onApplicationDataStateChanged(callbackFn: ValueChangeCallback<LifecycleState | undefined>): () => void;
}
export {};