@vertigis/viewer-spec/messaging/registry/licensing.d.ts

VertiGIS Viewer Specification

import type { Command } from "../Command.js";
import { CommandRegistry } from "../CommandRegistry.js";
import type { Operation } from "../Operation.js";
import { OperationRegistry } from "../OperationRegistry.js";
export declare class LicenseRequestArgs {
    /**
     * The human readable application name, used for any licensing related ui.
     * Web only.
     *
     * @webOnly
     */
    applicationName?: string;
    /**
     * The accountId (orgId) that we want to check licensing.
     */
    accountId?: string;
    /**
     * Overwrite the SKU for license check.
     */
    sku?: string;
}
export declare class LicensingCommands extends CommandRegistry {
    protected readonly _prefix = "licensing";
    /**
     * Validate the current application license and show appropriate prompts or
     * errors. Web only.
     *
     * @webOnly
     */
    get validateLicense(): Command<LicenseRequestArgs>;
}
export declare class LicensingOperations extends OperationRegistry {
    protected readonly _prefix = "licensing";
    /**
     * Retrieve the license state for the specified account and SKU. Defaults to
     * returning the current state.
     */
    get getLicenseState(): Operation<LicenseRequestArgs, string>;
}