Class InstallService

Index

Constructors

Methods

getInstallSettings postInstallSetup postInstallValidateDatabase

Constructors

constructor

new InstallService(): InstallService
Returns InstallService

Methods

`Static`getInstallSettings

getInstallSettings<ThrowOnError extends boolean = true>(
    options?: Options<GetInstallSettingsData, ThrowOnError>,
): RequestResult<
    GetInstallSettingsResponses,
    GetInstallSettingsErrors,
    ThrowOnError,
    "fields",
>
Gets install settings.

Gets the current installation settings and status.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetInstallSettingsData, ThrowOnError>
Returns RequestResult<
    GetInstallSettingsResponses,
    GetInstallSettingsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2913

`Static`postInstallSetup

postInstallSetup<ThrowOnError extends boolean = true>(
    options?: Options<PostInstallSetupData, ThrowOnError>,
): RequestResult<
    PostInstallSetupResponses,
    PostInstallSetupErrors,
    ThrowOnError,
    "fields",
>
Performs installation setup.

Performs the initial setup and installation of Umbraco.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostInstallSetupData, ThrowOnError>
Returns RequestResult<
    PostInstallSetupResponses,
    PostInstallSetupErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2925

`Static`postInstallValidateDatabase

postInstallValidateDatabase<ThrowOnError extends boolean = true>(
    options?: Options<PostInstallValidateDatabaseData, ThrowOnError>,
): RequestResult<
    PostInstallValidateDatabaseResponses,
    PostInstallValidateDatabaseErrors,
    ThrowOnError,
    "fields",
>
Validates database connection.

Validates the database connection settings provided during installation.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostInstallValidateDatabaseData, ThrowOnError>
Returns RequestResult<
    PostInstallValidateDatabaseResponses,
    PostInstallValidateDatabaseErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2941