Class UpgradeService

Index

Constructors

Methods

getUpgradeSettings postUpgradeAuthorize

Constructors

constructor

new UpgradeService(): UpgradeService
Returns UpgradeService

Methods

`Static`getUpgradeSettings

getUpgradeSettings<ThrowOnError extends boolean = true>(
    options?: Options<GetUpgradeSettingsData, ThrowOnError, unknown>,
): RequestResult<
    GetUpgradeSettingsResponses,
    GetUpgradeSettingsErrors,
    ThrowOnError,
    "fields",
>
Gets upgrade settings.

Gets the current upgrade settings and status for the Umbraco installation.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetUpgradeSettingsData, ThrowOnError, unknown>
Returns RequestResult<
    GetUpgradeSettingsResponses,
    GetUpgradeSettingsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:6353

`Static`postUpgradeAuthorize

postUpgradeAuthorize<ThrowOnError extends boolean = true>(
    options?: Options<PostUpgradeAuthorizeData, ThrowOnError, unknown>,
): RequestResult<
    PostUpgradeAuthorizeResponses,
    PostUpgradeAuthorizeErrors,
    ThrowOnError,
    "fields",
>
Authorizes the upgrade.

Authorizes the currently authenticated user to perform the upgrade.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostUpgradeAuthorizeData, ThrowOnError, unknown>
Returns RequestResult<
    PostUpgradeAuthorizeResponses,
    PostUpgradeAuthorizeErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:6340