Class PartialViewService

Index

Constructors

Methods

deletePartialViewByPath deletePartialViewFolderByPath getItemPartialView getPartialViewByPath getPartialViewFolderByPath getPartialViewSnippet getPartialViewSnippetById getTreePartialViewAncestors getTreePartialViewChildren getTreePartialViewRoot getTreePartialViewSiblings postPartialView postPartialViewFolder putPartialViewByPath putPartialViewByPathRename

Constructors

constructor

new PartialViewService(): PartialViewService
Returns PartialViewService

Methods

`Static`deletePartialViewByPath

deletePartialViewByPath<ThrowOnError extends boolean = true>(
    options: Options<DeletePartialViewByPathData, ThrowOnError>,
): RequestResult<
    DeletePartialViewByPathResponses,
    DeletePartialViewByPathErrors,
    ThrowOnError,
    "fields",
>
Deletes a partial view.

Deletes a partial view identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeletePartialViewByPathData, ThrowOnError>
Returns RequestResult<
    DeletePartialViewByPathResponses,
    DeletePartialViewByPathErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5025

`Static`deletePartialViewFolderByPath

deletePartialViewFolderByPath<ThrowOnError extends boolean = true>(
    options: Options<DeletePartialViewFolderByPathData, ThrowOnError>,
): RequestResult<
    DeletePartialViewFolderByPathResponses,
    DeletePartialViewFolderByPathErrors,
    ThrowOnError,
    "fields",
>
Deletes a partial view folder.

Deletes a partial view folder identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeletePartialViewFolderByPathData, ThrowOnError>
Returns RequestResult<
    DeletePartialViewFolderByPathResponses,
    DeletePartialViewFolderByPathErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5102

`Static`getItemPartialView

getItemPartialView<ThrowOnError extends boolean = true>(
    options?: Options<GetItemPartialViewData, ThrowOnError, unknown>,
): RequestResult<
    GetItemPartialViewResponses,
    GetItemPartialViewErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of partial view items.

Gets a collection of partial view items identified by the provided Ids.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetItemPartialViewData, ThrowOnError, unknown>
Returns RequestResult<
    GetItemPartialViewResponses,
    GetItemPartialViewErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:4995

`Static`getPartialViewByPath

getPartialViewByPath<ThrowOnError extends boolean = true>(
    options: Options<GetPartialViewByPathData, ThrowOnError>,
): RequestResult<
    GetPartialViewByPathResponses,
    GetPartialViewByPathErrors,
    ThrowOnError,
    "fields",
>
Gets a partial view by path.

Gets a partial view identified by the provided file path.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetPartialViewByPathData, ThrowOnError>
Returns RequestResult<
    GetPartialViewByPathResponses,
    GetPartialViewByPathErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5038

`Static`getPartialViewFolderByPath

getPartialViewFolderByPath<ThrowOnError extends boolean = true>(
    options: Options<GetPartialViewFolderByPathData, ThrowOnError>,
): RequestResult<
    GetPartialViewFolderByPathResponses,
    GetPartialViewFolderByPathErrors,
    ThrowOnError,
    "fields",
>
Gets a partial view folder by path.

Gets a partial view folder identified by the provided file path.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetPartialViewFolderByPathData, ThrowOnError>
Returns RequestResult<
    GetPartialViewFolderByPathResponses,
    GetPartialViewFolderByPathErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5115

`Static`getPartialViewSnippet

getPartialViewSnippet<ThrowOnError extends boolean = true>(
    options?: Options<GetPartialViewSnippetData, ThrowOnError, unknown>,
): RequestResult<
    GetPartialViewSnippetResponses,
    GetPartialViewSnippetErrors,
    ThrowOnError,
    "fields",
>
Gets a paginated collection of partial view snippets.

Gets a paginated collection of available partial view code snippets that can be used when creating new partial views.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetPartialViewSnippetData, ThrowOnError, unknown>
Returns RequestResult<
    GetPartialViewSnippetResponses,
    GetPartialViewSnippetErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5128

`Static`getPartialViewSnippetById

getPartialViewSnippetById<ThrowOnError extends boolean = true>(
    options: Options<GetPartialViewSnippetByIdData, ThrowOnError>,
): RequestResult<
    GetPartialViewSnippetByIdResponses,
    GetPartialViewSnippetByIdErrors,
    ThrowOnError,
    "fields",
>
Gets a partial view snippet.

Gets a partial view snippet identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetPartialViewSnippetByIdData, ThrowOnError>
Returns RequestResult<
    GetPartialViewSnippetByIdResponses,
    GetPartialViewSnippetByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5141

`Static`getTreePartialViewAncestors

getTreePartialViewAncestors<ThrowOnError extends boolean = true>(
    options?: Options<
        GetTreePartialViewAncestorsData,
        ThrowOnError,
        unknown,
    >,
): RequestResult<
    GetTreePartialViewAncestorsResponses,
    GetTreePartialViewAncestorsErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of ancestor partial view items.

Gets a collection of partial view items that are ancestors to the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreePartialViewAncestorsData, ThrowOnError, unknown>
Returns RequestResult<
    GetTreePartialViewAncestorsResponses,
    GetTreePartialViewAncestorsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5154

`Static`getTreePartialViewChildren

getTreePartialViewChildren<ThrowOnError extends boolean = true>(
    options?: Options<GetTreePartialViewChildrenData, ThrowOnError, unknown>,
): RequestResult<
    GetTreePartialViewChildrenResponses,
    GetTreePartialViewChildrenErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of partial view tree child items.

Gets a paginated collection of partial view tree items that are children of the provided parent Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreePartialViewChildrenData, ThrowOnError, unknown>
Returns RequestResult<
    GetTreePartialViewChildrenResponses,
    GetTreePartialViewChildrenErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5167

`Static`getTreePartialViewRoot

getTreePartialViewRoot<ThrowOnError extends boolean = true>(
    options?: Options<GetTreePartialViewRootData, ThrowOnError, unknown>,
): RequestResult<
    GetTreePartialViewRootResponses,
    GetTreePartialViewRootErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of partial view items from the root of the tree.

Gets a paginated collection of partial view items from the root of the tree with optional filtering.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreePartialViewRootData, ThrowOnError, unknown>
Returns RequestResult<
    GetTreePartialViewRootResponses,
    GetTreePartialViewRootErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5180

`Static`getTreePartialViewSiblings

getTreePartialViewSiblings<ThrowOnError extends boolean = true>(
    options?: Options<GetTreePartialViewSiblingsData, ThrowOnError, unknown>,
): RequestResult<
    GetTreePartialViewSiblingsResponses,
    GetTreePartialViewSiblingsErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of partial view tree sibling items.

Gets a collection of partial view tree items that are siblings of the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreePartialViewSiblingsData, ThrowOnError, unknown>
Returns RequestResult<
    GetTreePartialViewSiblingsResponses,
    GetTreePartialViewSiblingsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5193

`Static`postPartialView

postPartialView<ThrowOnError extends boolean = true>(
    options: Options<PostPartialViewData, ThrowOnError>,
): RequestResult<
    PostPartialViewResponses,
    PostPartialViewErrors,
    ThrowOnError,
    "fields",
>
Creates a new partial view.

Creates a new partial view with the configuration specified in the request model.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostPartialViewData, ThrowOnError>
Returns RequestResult<
    PostPartialViewResponses,
    PostPartialViewErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5008

`Static`postPartialViewFolder

postPartialViewFolder<ThrowOnError extends boolean = true>(
    options: Options<PostPartialViewFolderData, ThrowOnError>,
): RequestResult<
    PostPartialViewFolderResponses,
    PostPartialViewFolderErrors,
    ThrowOnError,
    "fields",
>
Creates a partial view folder.

Creates a new partial view folder with the provided name and parent location.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostPartialViewFolderData, ThrowOnError>
Returns RequestResult<
    PostPartialViewFolderResponses,
    PostPartialViewFolderErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5085

`Static`putPartialViewByPath

putPartialViewByPath<ThrowOnError extends boolean = true>(
    options: Options<PutPartialViewByPathData, ThrowOnError>,
): RequestResult<
    PutPartialViewByPathResponses,
    PutPartialViewByPathErrors,
    ThrowOnError,
    "fields",
>
Updates a partial view.

Updates a partial view identified by the provided Id with the details from the request model.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutPartialViewByPathData, ThrowOnError>
Returns RequestResult<
    PutPartialViewByPathResponses,
    PutPartialViewByPathErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5051

`Static`putPartialViewByPathRename

putPartialViewByPathRename<ThrowOnError extends boolean = true>(
    options: Options<PutPartialViewByPathRenameData, ThrowOnError>,
): RequestResult<
    PutPartialViewByPathRenameResponses,
    PutPartialViewByPathRenameErrors,
    ThrowOnError,
    "fields",
>
Renames a partial view.

Renames a partial view file to the specified new name.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutPartialViewByPathRenameData, ThrowOnError>
Returns RequestResult<
    PutPartialViewByPathRenameResponses,
    PutPartialViewByPathRenameErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5068

Class PartialViewService

Index

Constructors

Methods

Constructors

constructor

Returns PartialViewService

Methods

StaticdeletePartialViewByPath

Type Parameters

Parameters

Returns RequestResult< DeletePartialViewByPathResponses, DeletePartialViewByPathErrors, ThrowOnError, "fields",>

StaticdeletePartialViewFolderByPath

Type Parameters

Parameters

Returns RequestResult< DeletePartialViewFolderByPathResponses, DeletePartialViewFolderByPathErrors, ThrowOnError, "fields",>

StaticgetItemPartialView

Type Parameters

Parameters

Returns RequestResult< GetItemPartialViewResponses, GetItemPartialViewErrors, ThrowOnError, "fields",>

StaticgetPartialViewByPath

Type Parameters

Parameters

Returns RequestResult< GetPartialViewByPathResponses, GetPartialViewByPathErrors, ThrowOnError, "fields",>

StaticgetPartialViewFolderByPath

Type Parameters

Parameters

Returns RequestResult< GetPartialViewFolderByPathResponses, GetPartialViewFolderByPathErrors, ThrowOnError, "fields",>

StaticgetPartialViewSnippet

Type Parameters

Parameters

Returns RequestResult< GetPartialViewSnippetResponses, GetPartialViewSnippetErrors, ThrowOnError, "fields",>

StaticgetPartialViewSnippetById

Type Parameters

Parameters

Returns RequestResult< GetPartialViewSnippetByIdResponses, GetPartialViewSnippetByIdErrors, ThrowOnError, "fields",>

StaticgetTreePartialViewAncestors

Type Parameters

Parameters

Returns RequestResult< GetTreePartialViewAncestorsResponses, GetTreePartialViewAncestorsErrors, ThrowOnError, "fields",>

StaticgetTreePartialViewChildren

Type Parameters

Parameters

Returns RequestResult< GetTreePartialViewChildrenResponses, GetTreePartialViewChildrenErrors, ThrowOnError, "fields",>

StaticgetTreePartialViewRoot

Type Parameters

Parameters

Returns RequestResult< GetTreePartialViewRootResponses, GetTreePartialViewRootErrors, ThrowOnError, "fields",>

StaticgetTreePartialViewSiblings

Type Parameters

Parameters

Returns RequestResult< GetTreePartialViewSiblingsResponses, GetTreePartialViewSiblingsErrors, ThrowOnError, "fields",>

StaticpostPartialView

Type Parameters

Parameters

Returns RequestResult< PostPartialViewResponses, PostPartialViewErrors, ThrowOnError, "fields",>

StaticpostPartialViewFolder

Type Parameters

Parameters

Returns RequestResult< PostPartialViewFolderResponses, PostPartialViewFolderErrors, ThrowOnError, "fields",>

StaticputPartialViewByPath

Type Parameters

Parameters

Returns RequestResult< PutPartialViewByPathResponses, PutPartialViewByPathErrors, ThrowOnError, "fields",>

StaticputPartialViewByPathRename

Type Parameters

Parameters

Returns RequestResult< PutPartialViewByPathRenameResponses, PutPartialViewByPathRenameErrors, ThrowOnError, "fields",>

Settings

On This Page

`Static`deletePartialViewByPath

Returns RequestResult<
DeletePartialViewByPathResponses,
DeletePartialViewByPathErrors,
ThrowOnError,
"fields",
>

`Static`deletePartialViewFolderByPath

Returns RequestResult<
DeletePartialViewFolderByPathResponses,
DeletePartialViewFolderByPathErrors,
ThrowOnError,
"fields",
>

`Static`getItemPartialView

Returns RequestResult<
GetItemPartialViewResponses,
GetItemPartialViewErrors,
ThrowOnError,
"fields",
>

`Static`getPartialViewByPath

Returns RequestResult<
GetPartialViewByPathResponses,
GetPartialViewByPathErrors,
ThrowOnError,
"fields",
>

`Static`getPartialViewFolderByPath

Returns RequestResult<
GetPartialViewFolderByPathResponses,
GetPartialViewFolderByPathErrors,
ThrowOnError,
"fields",
>

`Static`getPartialViewSnippet

Returns RequestResult<
GetPartialViewSnippetResponses,
GetPartialViewSnippetErrors,
ThrowOnError,
"fields",
>

`Static`getPartialViewSnippetById

Returns RequestResult<
GetPartialViewSnippetByIdResponses,
GetPartialViewSnippetByIdErrors,
ThrowOnError,
"fields",
>

`Static`getTreePartialViewAncestors

Returns RequestResult<
GetTreePartialViewAncestorsResponses,
GetTreePartialViewAncestorsErrors,
ThrowOnError,
"fields",
>

`Static`getTreePartialViewChildren

Returns RequestResult<
GetTreePartialViewChildrenResponses,
GetTreePartialViewChildrenErrors,
ThrowOnError,
"fields",
>

`Static`getTreePartialViewRoot

Returns RequestResult<
GetTreePartialViewRootResponses,
GetTreePartialViewRootErrors,
ThrowOnError,
"fields",
>

`Static`getTreePartialViewSiblings

Returns RequestResult<
GetTreePartialViewSiblingsResponses,
GetTreePartialViewSiblingsErrors,
ThrowOnError,
"fields",
>

`Static`postPartialView

Returns RequestResult<
PostPartialViewResponses,
PostPartialViewErrors,
ThrowOnError,
"fields",
>

`Static`postPartialViewFolder

Returns RequestResult<
PostPartialViewFolderResponses,
PostPartialViewFolderErrors,
ThrowOnError,
"fields",
>

`Static`putPartialViewByPath

Returns RequestResult<
PutPartialViewByPathResponses,
PutPartialViewByPathErrors,
ThrowOnError,
"fields",
>

`Static`putPartialViewByPathRename

Returns RequestResult<
PutPartialViewByPathRenameResponses,
PutPartialViewByPathRenameErrors,
ThrowOnError,
"fields",
>