Interface PresetBase

interface PresetBase {
    id: string;
    name: string;
    description: string;
    companyId: string;
    companyName: string;
    iconFilePath: string;
    secret: string;
    isDefaultAutoProcessingRuntimeUpdateEnabled: boolean;
    defaultAutoProcessingRuntimeUpdateMode: "optional" | "required";
    defaultAutoProcessingRuntimeUpdateOptionalModeUpdateAvailableDialog: {
        titleTemplate: string;
        messageTemplate: string;
    };
    defaultAutoProcessingRuntimeUpdateRequiredModeUpdateAvailableDialog: {
        titleTemplate: string;
        messageTemplate: string;
    };
    assets: {
        [assetId: string]: AssetPreset;
    };
    appsCatalogId: string;
    appMainBranchDefaultRootDir: AppBranchDefaultRootDirPreset;
    appSecondaryBranchDefaultRootDir: AppBranchDefaultRootDirPreset;
    isAppBranchNotDefaultRootDirAllowed: boolean;
    isStartingQuitTaskAllowedIfAnyAppBranchProcessExists: boolean;
    window: WindowPreset;
    agreements: {
        [agreementId: string]: AgreementPreset;
    };
    statsAgreementId?: string;
    isStatsEntryAnonymous: boolean;
    reportingErrorAgreementId?: string;
    availableLangs: {
        [availableLangTag: string]: AvailableLangPreset;
    };
    fallbackLangTag: string;
    protocol?: ProtocolPreset;
    isAutoShowingWindowOnProtocolPendingRequestRegisteredEnabled: boolean;
    isAutoFocusingWindowOnProtocolPendingRequestRegisteredEnabled: boolean;
    tray?: TrayPreset;
    loadingThemeErrorDialog: {
        titleTemplate: string;
        messageTemplate: string;
    };
    logsCollectedDialog: {
        titleTemplate: string;
        messageTemplate: string;
    };
    crashedDialog: {
        titleTemplate: string;
        messageTemplate: string;
    };
}

Hierarchy (view full)

Properties

id name description companyId companyName iconFilePath secret isDefaultAutoProcessingRuntimeUpdateEnabled defaultAutoProcessingRuntimeUpdateMode defaultAutoProcessingRuntimeUpdateOptionalModeUpdateAvailableDialog defaultAutoProcessingRuntimeUpdateRequiredModeUpdateAvailableDialog assets appsCatalogId appMainBranchDefaultRootDir appSecondaryBranchDefaultRootDir isAppBranchNotDefaultRootDirAllowed isStartingQuitTaskAllowedIfAnyAppBranchProcessExists window agreements statsAgreementId? isStatsEntryAnonymous reportingErrorAgreementId? availableLangs fallbackLangTag protocol? isAutoShowingWindowOnProtocolPendingRequestRegisteredEnabled isAutoFocusingWindowOnProtocolPendingRequestRegisteredEnabled tray? loadingThemeErrorDialog logsCollectedDialog crashedDialog

Properties

id

id: string

WARNING: Once your launcher is published, you should never change this value. If you need to do so, you must perform a migration process (currently undocumented, please contact PatchKit Support for assistance).

Used for:

  • the default path of the launcher installation directory
  • the path of directories where the launcher will store its data

name

name: string

Used for:

  • the name of the launcher executable
  • the name of the launcher setup
  • the name of the launcher shortcut

description

description: string

companyId

companyId: string

companyName

companyName: string

WARNING: Once your launcher is published, you should never change this value. If you need to do so, you must perform a migration process (currently undocumented, please contact PatchKit Support for assistance).

iconFilePath

iconFilePath: string

Path is relative to the launcher runtime package root directory.

secret

secret: string

Insert the secret of your launcher entry created on PatchKit Panel.

Learn more about this here.

isDefaultAutoProcessingRuntimeUpdateEnabled

isDefaultAutoProcessingRuntimeUpdateEnabled: boolean

When set to false, the launcher will not process updates with the default procedure (in such cases, you need to implement the update procedure yourself in the launcher theme using the runtime API).

defaultAutoProcessingRuntimeUpdateMode

defaultAutoProcessingRuntimeUpdateMode: "optional" | "required"

Determines whether launcher updates are required or optional in the default procedure.

defaultAutoProcessingRuntimeUpdateOptionalModeUpdateAvailableDialog

defaultAutoProcessingRuntimeUpdateOptionalModeUpdateAvailableDialog: {
    titleTemplate: string;
    messageTemplate: string;
}

Determines the configuration of dialog displayed when a launcher update is available in the default procedure (and the mode is set to optional).

Type declaration

  • titleTemplate: string

    Title template for the dialog.

  • messageTemplate: string

    Message template for the dialog.

defaultAutoProcessingRuntimeUpdateRequiredModeUpdateAvailableDialog

defaultAutoProcessingRuntimeUpdateRequiredModeUpdateAvailableDialog: {
    titleTemplate: string;
    messageTemplate: string;
}

Determines the configuration of dialog displayed when a launcher update is available in the default procedure (and the mode is set to required).

Type declaration

  • titleTemplate: string

    Title template for the dialog.

  • messageTemplate: string

    Message template for the dialog.

assets

assets: {
    [assetId: string]: AssetPreset;
}

Determines the configuration of the launcher assets.

appsCatalogId

appsCatalogId: string

Insert the ID of your app catalog entry created on PatchKit Panel.

Learn more about this here.

appMainBranchDefaultRootDir

appMainBranchDefaultRootDir: AppBranchDefaultRootDirPreset

Determines the configuration of default root directories for app main branches registered in the launcher.

appSecondaryBranchDefaultRootDir

appSecondaryBranchDefaultRootDir: AppBranchDefaultRootDirPreset

Determines the configuration of default root directories for app secondary branches registered in the launcher.

isAppBranchNotDefaultRootDirAllowed

isAppBranchNotDefaultRootDirAllowed: boolean

If set to true, only directories resolved with appMainBranchDefaultRootDir and appSecondaryBranchDefaultRootDir configurations are allowed as root directories for app branches registered in the launcher.

isStartingQuitTaskAllowedIfAnyAppBranchProcessExists

isStartingQuitTaskAllowedIfAnyAppBranchProcessExists: boolean

If set to true, the launcher will not allow starting the quit task if any app branch process is running.

window

window: WindowPreset

Determines the configuration of the launcher window.

agreements

agreements: {
    [agreementId: string]: AgreementPreset;
}

Determines the configuration of the launcher agreements.

OptionalstatsAgreementId

statsAgreementId?: string

isStatsEntryAnonymous

isStatsEntryAnonymous: boolean

OptionalreportingErrorAgreementId

reportingErrorAgreementId?: string

availableLangs

availableLangs: {
    [availableLangTag: string]: AvailableLangPreset;
}

Determines the configuration of the launcher available languages.

fallbackLangTag

fallbackLangTag: string

Optionalprotocol

protocol?: ProtocolPreset

Determines the configuration of the launcher protocol.

If not set, the protocol will not be registered by the launcher.

isAutoShowingWindowOnProtocolPendingRequestRegisteredEnabled

isAutoShowingWindowOnProtocolPendingRequestRegisteredEnabled: boolean

If set to true, the launcher will automatically show the window when a protocol pending request is registered.

isAutoFocusingWindowOnProtocolPendingRequestRegisteredEnabled

isAutoFocusingWindowOnProtocolPendingRequestRegisteredEnabled: boolean

If set to true, the launcher will automatically focus the window when a protocol pending request is registered.

Optionaltray

tray?: TrayPreset

Determines the configuration of the launcher tray.

If not set, the tray will not be registered by the launcher.

loadingThemeErrorDialog

loadingThemeErrorDialog: {
    titleTemplate: string;
    messageTemplate: string;
}

Determines the configuration of dialog displayed when the launcher encounters an error while loading the theme.

Type declaration

  • titleTemplate: string

    Title template for the dialog.

  • messageTemplate: string

    Message template for the dialog.

logsCollectedDialog

logsCollectedDialog: {
    titleTemplate: string;
    messageTemplate: string;
}

Determines the configuration of dialog displayed when the launcher successfully collects the logs.

Type declaration

  • titleTemplate: string

    Title template for the dialog.

  • messageTemplate: string

    Message template for the dialog.

    Available variables:

    • {logsZipFileInfoName} - the name of the logs zip file
    • {logsZipFileInfoPath} - the path of the logs zip file

crashedDialog

crashedDialog: {
    titleTemplate: string;
    messageTemplate: string;
}

Determines the configuration of dialog displayed when the launcher crashes.

Type declaration

  • titleTemplate: string

    Title template for the dialog.

  • messageTemplate: string

    Message template for the dialog.

    Available variables:

    • {logsZipFileInfoName} - the name of the logs zip file
    • {logsZipFileInfoPath} - the path of the logs zip file

Settings

On This Page

Properties