Class PreviewService

Index

Constructors

Methods

deletePreview postPreview

Constructors

constructor

new PreviewService(): PreviewService
Returns PreviewService

Methods

`Static`deletePreview

deletePreview<ThrowOnError extends boolean = true>(
options?: Options<DeletePreviewData, ThrowOnError>,
): RequestResult<DeletePreviewResponses, unknown, ThrowOnError, "fields">
Exits preview mode. Exits preview mode and returns to the normal back office viewing experience.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<DeletePreviewData, ThrowOnError>
Returns RequestResult<DeletePreviewResponses, unknown, ThrowOnError, "fields">
- Defined in src/packages/core/backend-api/sdk.gen.ts:5534

`Static`postPreview

postPreview<ThrowOnError extends boolean = true>(
    options?: Options<PostPreviewData, ThrowOnError>,
): RequestResult<
    PostPreviewResponses,
    PostPreviewErrors,
    ThrowOnError,
    "fields",
>
Enters preview mode. Enters preview mode for the current user session, allowing viewing of unpublished content.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostPreviewData, ThrowOnError>
Returns RequestResult<PostPreviewResponses, PostPreviewErrors, ThrowOnError, "fields">
Deprecated
- Defined in src/packages/core/backend-api/sdk.gen.ts:5546