Class StaticFileService

Index

Constructors

constructor

Methods

getItemStaticFile getTreeStaticFileAncestors getTreeStaticFileChildren getTreeStaticFileRoot

Constructors

constructor

new StaticFileService(): StaticFileService
Returns StaticFileService

Methods

`Static`getItemStaticFile

getItemStaticFile<ThrowOnError extends boolean = true>(
    options?: Options<GetItemStaticFileData, ThrowOnError>,
): RequestResult<
    GetItemStaticFileResponses,
    GetItemStaticFileErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of static file items.

Gets a collection of static file items identified by the provided Ids.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetItemStaticFileData, ThrowOnError>
Returns RequestResult<
    GetItemStaticFileResponses,
    GetItemStaticFileErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:6744

`Static`getTreeStaticFileAncestors

getTreeStaticFileAncestors<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeStaticFileAncestorsData, ThrowOnError>,
): RequestResult<
    GetTreeStaticFileAncestorsResponses,
    GetTreeStaticFileAncestorsErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of ancestor static file items.

Gets a collection of static file items that are ancestors to the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeStaticFileAncestorsData, ThrowOnError>
Returns RequestResult<
    GetTreeStaticFileAncestorsResponses,
    GetTreeStaticFileAncestorsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:6762

`Static`getTreeStaticFileChildren

getTreeStaticFileChildren<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeStaticFileChildrenData, ThrowOnError>,
): RequestResult<
    GetTreeStaticFileChildrenResponses,
    GetTreeStaticFileChildrenErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of static file tree child items.

Gets a paginated collection of static file tree items that are children of the provided parent Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeStaticFileChildrenData, ThrowOnError>
Returns RequestResult<
    GetTreeStaticFileChildrenResponses,
    GetTreeStaticFileChildrenErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:6780

`Static`getTreeStaticFileRoot

getTreeStaticFileRoot<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeStaticFileRootData, ThrowOnError>,
): RequestResult<
    GetTreeStaticFileRootResponses,
    GetTreeStaticFileRootErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of static file items from the root of the tree.

Gets a paginated collection of static file items from the root of the tree with optional filtering.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeStaticFileRootData, ThrowOnError>
Returns RequestResult<
    GetTreeStaticFileRootResponses,
    GetTreeStaticFileRootErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:6798

Class StaticFileService

Index

Constructors

Methods

Constructors

constructor

Returns StaticFileService

Methods

`Static`getItemStaticFile

Type Parameters

Parameters

Returns RequestResult<
    GetItemStaticFileResponses,
    GetItemStaticFileErrors,
    ThrowOnError,
    "fields",
>

`Static`getTreeStaticFileAncestors

Type Parameters

Parameters

Returns RequestResult<
    GetTreeStaticFileAncestorsResponses,
    GetTreeStaticFileAncestorsErrors,
    ThrowOnError,
    "fields",
>

`Static`getTreeStaticFileChildren

Type Parameters

Parameters

Returns RequestResult<
    GetTreeStaticFileChildrenResponses,
    GetTreeStaticFileChildrenErrors,
    ThrowOnError,
    "fields",
>

`Static`getTreeStaticFileRoot

Type Parameters

Parameters

Returns RequestResult<
    GetTreeStaticFileRootResponses,
    GetTreeStaticFileRootErrors,
    ThrowOnError,
    "fields",
>

Settings

On This Page

Class StaticFileService

Index

Constructors

Methods

Constructors

constructor

Returns StaticFileService

Methods

StaticgetItemStaticFile

Type Parameters

Parameters

Returns RequestResult< GetItemStaticFileResponses, GetItemStaticFileErrors, ThrowOnError, "fields",>

StaticgetTreeStaticFileAncestors

Type Parameters

Parameters

Returns RequestResult< GetTreeStaticFileAncestorsResponses, GetTreeStaticFileAncestorsErrors, ThrowOnError, "fields",>

StaticgetTreeStaticFileChildren

Type Parameters

Parameters

Returns RequestResult< GetTreeStaticFileChildrenResponses, GetTreeStaticFileChildrenErrors, ThrowOnError, "fields",>

StaticgetTreeStaticFileRoot

Type Parameters

Parameters

Returns RequestResult< GetTreeStaticFileRootResponses, GetTreeStaticFileRootErrors, ThrowOnError, "fields",>

Settings

On This Page

`Static`getItemStaticFile

Returns RequestResult<
GetItemStaticFileResponses,
GetItemStaticFileErrors,
ThrowOnError,
"fields",
>

`Static`getTreeStaticFileAncestors

Returns RequestResult<
GetTreeStaticFileAncestorsResponses,
GetTreeStaticFileAncestorsErrors,
ThrowOnError,
"fields",
>

`Static`getTreeStaticFileChildren

Returns RequestResult<
GetTreeStaticFileChildrenResponses,
GetTreeStaticFileChildrenErrors,
ThrowOnError,
"fields",
>

`Static`getTreeStaticFileRoot

Returns RequestResult<
GetTreeStaticFileRootResponses,
GetTreeStaticFileRootErrors,
ThrowOnError,
"fields",
>