@sitecore/sc-contenthub-webclient-sdk/esm/clients/version-checker.d.ts

Sitecore Content Hub WebClient SDK.

import { FileVersion } from "../fileversion";
import { Compatibility } from "../models/versionining/compatibility";
import { IApiClient } from "./api-client";
export interface IVersionChecker {
    /**
     * Gets the compatibility between a Content Hub instance and SDK.
     * @param serverVersion - File version of a Content Hub instance.
     * @param sdkVersion - File version of the SDK.
     * @param minimumSdkVersion - File version of the minimum SDK version as dictated by the Content Hub instance.
     * @returns The compatibility.
     */
    getCompatibility(serverVersion: FileVersion, sdkVersion: FileVersion, minimumSdkVersion: FileVersion): Compatibility;
    /**
     * Check compatibility of a Content Hub instance with minimum required SDK version.
     * @param requiredVersion - File version required.
     */
    compatibilityCheckAsync(requiredVersion: FileVersion): Promise<void>;
    /**
     * Return compatibility of the Content Hub instance.
     * @param requiredVersion - File version required.
     * @returns True is it's compatible, false otherwise.
     */
    isCompatibleAsync(requiredVersion: FileVersion): Promise<boolean>;
}
export declare class VersionChecker implements IVersionChecker {
    private client;
    constructor(client: IApiClient);
    getCompatibility(serverVersion: FileVersion, sdkVersion: FileVersion, minimumSdkVersion: FileVersion): Compatibility;
    compatibilityCheckAsync(requiredVersion: FileVersion): Promise<void>;
    isCompatibleAsync(requiredVersion: FileVersion): Promise<boolean>;
    private isDebugVersion;
}