Class PublishedCacheService

Index

Constructors

constructor

Methods

getPublishedCacheRebuildStatus postPublishedCacheRebuild postPublishedCacheReload

Constructors

constructor

new PublishedCacheService(): PublishedCacheService
Returns PublishedCacheService

Methods

`Static`getPublishedCacheRebuildStatus

getPublishedCacheRebuildStatus<ThrowOnError extends boolean = true>(
    options?: Options<GetPublishedCacheRebuildStatusData, ThrowOnError>,
): RequestResult<
    GetPublishedCacheRebuildStatusResponses,
    GetPublishedCacheRebuildStatusErrors,
    ThrowOnError,
    "fields",
>
Gets the rebuild cache status. Gets the current status of the published content cache rebuild operation.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetPublishedCacheRebuildStatusData, ThrowOnError>
Returns RequestResult<
    GetPublishedCacheRebuildStatusResponses,
    GetPublishedCacheRebuildStatusErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5641

`Static`postPublishedCacheRebuild

postPublishedCacheRebuild<ThrowOnError extends boolean = true>(
    options?: Options<PostPublishedCacheRebuildData, ThrowOnError>,
): RequestResult<
    PostPublishedCacheRebuildResponses,
    PostPublishedCacheRebuildErrors,
    ThrowOnError,
    "fields",
>
Rebuilds the published content cache. Rebuilds the entire published content cache from scratch.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostPublishedCacheRebuildData, ThrowOnError>
Returns RequestResult<
    PostPublishedCacheRebuildResponses,
    PostPublishedCacheRebuildErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5624

`Static`postPublishedCacheReload

postPublishedCacheReload<ThrowOnError extends boolean = true>(
    options?: Options<PostPublishedCacheReloadData, ThrowOnError>,
): RequestResult<
    PostPublishedCacheReloadResponses,
    PostPublishedCacheReloadErrors,
    ThrowOnError,
    "fields",
>
Reloads the published content cache. Reloads the published content cache from the database.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostPublishedCacheReloadData, ThrowOnError>
Returns RequestResult<
    PostPublishedCacheReloadResponses,
    PostPublishedCacheReloadErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5658

Class PublishedCacheService

Index

Constructors

Methods

Constructors

constructor

Returns PublishedCacheService

Methods

`Static`getPublishedCacheRebuildStatus

Type Parameters

Parameters

Returns RequestResult<
    GetPublishedCacheRebuildStatusResponses,
    GetPublishedCacheRebuildStatusErrors,
    ThrowOnError,
    "fields",
>

`Static`postPublishedCacheRebuild

Type Parameters

Parameters

Returns RequestResult<
    PostPublishedCacheRebuildResponses,
    PostPublishedCacheRebuildErrors,
    ThrowOnError,
    "fields",
>

`Static`postPublishedCacheReload

Type Parameters

Parameters

Returns RequestResult<
    PostPublishedCacheReloadResponses,
    PostPublishedCacheReloadErrors,
    ThrowOnError,
    "fields",
>

Settings

On This Page

Class PublishedCacheService

Index

Constructors

Methods

Constructors

constructor

Returns PublishedCacheService

Methods

StaticgetPublishedCacheRebuildStatus

Type Parameters

Parameters

Returns RequestResult< GetPublishedCacheRebuildStatusResponses, GetPublishedCacheRebuildStatusErrors, ThrowOnError, "fields",>

StaticpostPublishedCacheRebuild

Type Parameters

Parameters

Returns RequestResult< PostPublishedCacheRebuildResponses, PostPublishedCacheRebuildErrors, ThrowOnError, "fields",>

StaticpostPublishedCacheReload

Type Parameters

Parameters

Returns RequestResult< PostPublishedCacheReloadResponses, PostPublishedCacheReloadErrors, ThrowOnError, "fields",>

Settings

On This Page

`Static`getPublishedCacheRebuildStatus

Returns RequestResult<
GetPublishedCacheRebuildStatusResponses,
GetPublishedCacheRebuildStatusErrors,
ThrowOnError,
"fields",
>

`Static`postPublishedCacheRebuild

Returns RequestResult<
PostPublishedCacheRebuildResponses,
PostPublishedCacheRebuildErrors,
ThrowOnError,
"fields",
>

`Static`postPublishedCacheReload

Returns RequestResult<
PostPublishedCacheReloadResponses,
PostPublishedCacheReloadErrors,
ThrowOnError,
"fields",
>