Class MediaService

Constructors

constructor

new MediaService(): MediaService
Returns MediaService

Methods

`Static`deleteMediaById

deleteMediaById<ThrowOnError extends boolean = true>(
options: Options<DeleteMediaByIdData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteMediaByIdData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2636

`Static`deleteRecycleBinMedia

deleteRecycleBinMedia<ThrowOnError extends boolean = true>(
options?: Options<DeleteRecycleBinMediaData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<DeleteRecycleBinMediaData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2841

`Static`deleteRecycleBinMediaById

deleteRecycleBinMediaById<ThrowOnError extends boolean = true>(
options: Options<DeleteRecycleBinMediaByIdData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteRecycleBinMediaByIdData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2854

`Static`getCollectionMedia

getCollectionMedia<ThrowOnError extends boolean = true>(
options?: Options<GetCollectionMediaData, ThrowOnError>,
): RequestResult<PagedMediaCollectionResponseModel, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetCollectionMediaData, ThrowOnError>
Returns RequestResult<PagedMediaCollectionResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2580

`Static`getItemMedia

getItemMedia<ThrowOnError extends boolean = true>(
options?: Options<GetItemMediaData, ThrowOnError>,
): RequestResult<MediaItemResponseModel[], unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetItemMediaData, ThrowOnError>
Returns RequestResult<MediaItemResponseModel[], unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2593

`Static`getItemMediaSearch

getItemMediaSearch<ThrowOnError extends boolean = true>(
options?: Options<GetItemMediaSearchData, ThrowOnError>,
): RequestResult<PagedModelMediaItemResponseModel, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetItemMediaSearchData, ThrowOnError>
Returns RequestResult<PagedModelMediaItemResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2606

`Static`getMediaAreReferenced

getMediaAreReferenced<ThrowOnError extends boolean = true>(
options?: Options<GetMediaAreReferencedData, ThrowOnError>,
): RequestResult<PagedReferenceByIdModel, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetMediaAreReferencedData, ThrowOnError>
Returns RequestResult<PagedReferenceByIdModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2765

`Static`getMediaById

getMediaById<ThrowOnError extends boolean = true>(
options: Options<GetMediaByIdData, ThrowOnError>,
): RequestResult<MediaResponseModel, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetMediaByIdData, ThrowOnError>
Returns RequestResult<MediaResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2649

`Static`getMediaConfiguration

getMediaConfiguration<ThrowOnError extends boolean = true>(
options?: Options<GetMediaConfigurationData, ThrowOnError>,
): RequestResult<MediaConfigurationResponseModel, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetMediaConfigurationData, ThrowOnError>
Returns RequestResult<MediaConfigurationResponseModel, unknown, ThrowOnError>
Deprecated
- Defined in src/packages/core/backend-api/sdk.gen.ts:2781

`Static`getMediaUrls

getMediaUrls<ThrowOnError extends boolean = true>(
options?: Options<GetMediaUrlsData, ThrowOnError>,
): RequestResult<MediaUrlInfoResponseModel[], unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetMediaUrlsData, ThrowOnError>
Returns RequestResult<MediaUrlInfoResponseModel[], unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2811

`Static`getRecycleBinMediaByIdOriginalParent

getRecycleBinMediaByIdOriginalParent<ThrowOnError extends boolean = true>(
options: Options<GetRecycleBinMediaByIdOriginalParentData, ThrowOnError>,
): RequestResult<ReferenceByIdModel, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetRecycleBinMediaByIdOriginalParentData, ThrowOnError>
Returns RequestResult<ReferenceByIdModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2867

`Static`getRecycleBinMediaChildren

getRecycleBinMediaChildren<ThrowOnError extends boolean = true>(
    options?: Options<GetRecycleBinMediaChildrenData, ThrowOnError>,
): RequestResult<
    PagedMediaRecycleBinItemResponseModel,
    unknown,
    ThrowOnError,
>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetRecycleBinMediaChildrenData, ThrowOnError>
Returns RequestResult<PagedMediaRecycleBinItemResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2897

`Static`getRecycleBinMediaReferencedBy

getRecycleBinMediaReferencedBy<ThrowOnError extends boolean = true>(
options?: Options<GetRecycleBinMediaReferencedByData, ThrowOnError>,
): RequestResult<PagedIReferenceResponseModel, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetRecycleBinMediaReferencedByData, ThrowOnError>
Returns RequestResult<PagedIReferenceResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2910

`Static`getRecycleBinMediaRoot

getRecycleBinMediaRoot<ThrowOnError extends boolean = true>(
    options?: Options<GetRecycleBinMediaRootData, ThrowOnError>,
): RequestResult<
    PagedMediaRecycleBinItemResponseModel,
    unknown,
    ThrowOnError,
>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetRecycleBinMediaRootData, ThrowOnError>
Returns RequestResult<PagedMediaRecycleBinItemResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2923

`Static`getTreeMediaAncestors

getTreeMediaAncestors<ThrowOnError extends boolean = true>(
options?: Options<GetTreeMediaAncestorsData, ThrowOnError>,
): RequestResult<MediaTreeItemResponseModel[], unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeMediaAncestorsData, ThrowOnError>
Returns RequestResult<MediaTreeItemResponseModel[], unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2936

`Static`getTreeMediaChildren

getTreeMediaChildren<ThrowOnError extends boolean = true>(
options?: Options<GetTreeMediaChildrenData, ThrowOnError>,
): RequestResult<PagedMediaTreeItemResponseModel, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeMediaChildrenData, ThrowOnError>
Returns RequestResult<PagedMediaTreeItemResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2949

`Static`getTreeMediaRoot

getTreeMediaRoot<ThrowOnError extends boolean = true>(
options?: Options<GetTreeMediaRootData, ThrowOnError>,
): RequestResult<PagedMediaTreeItemResponseModel, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeMediaRootData, ThrowOnError>
Returns RequestResult<PagedMediaTreeItemResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2962

`Static`postMedia

postMedia<ThrowOnError extends boolean = true>(
options?: Options<PostMediaData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostMediaData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2619

`Static`postMediaValidate

postMediaValidate<ThrowOnError extends boolean = true>(
options?: Options<PostMediaValidateData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostMediaValidateData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2824

`Static`putMediaById

putMediaById<ThrowOnError extends boolean = true>(
options: Options<PutMediaByIdData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutMediaByIdData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2662

`Static`putMediaByIdMove

putMediaByIdMove<ThrowOnError extends boolean = true>(
options: Options<PutMediaByIdMoveData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutMediaByIdMoveData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2692

`Static`putMediaByIdMoveToRecycleBin

putMediaByIdMoveToRecycleBin<ThrowOnError extends boolean = true>(
options: Options<PutMediaByIdMoveToRecycleBinData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutMediaByIdMoveToRecycleBinData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2709

`Static`putMediaByIdValidate

putMediaByIdValidate<ThrowOnError extends boolean = true>(
options: Options<PutMediaByIdValidateData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutMediaByIdValidateData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2748

`Static`putMediaSort

putMediaSort<ThrowOnError extends boolean = true>(
options?: Options<PutMediaSortData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PutMediaSortData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2794

`Static`putRecycleBinMediaByIdRestore

putRecycleBinMediaByIdRestore<ThrowOnError extends boolean = true>(
options: Options<PutRecycleBinMediaByIdRestoreData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutRecycleBinMediaByIdRestoreData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:2880

Class MediaService

Index

Constructors

Methods

Constructors

constructor

Returns MediaService

Methods

StaticdeleteMediaById

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

StaticdeleteRecycleBinMedia

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

StaticdeleteRecycleBinMediaById

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

StaticgetCollectionMedia

Type Parameters

Parameters

Returns RequestResult<PagedMediaCollectionResponseModel, unknown, ThrowOnError>

StaticgetItemMedia

Type Parameters

Parameters

Returns RequestResult<MediaItemResponseModel[], unknown, ThrowOnError>

StaticgetItemMediaSearch

Type Parameters

Parameters

Returns RequestResult<PagedModelMediaItemResponseModel, unknown, ThrowOnError>

StaticgetMediaAreReferenced

Type Parameters

Parameters

Returns RequestResult<PagedReferenceByIdModel, unknown, ThrowOnError>

StaticgetMediaById

Type Parameters

Parameters

Returns RequestResult<MediaResponseModel, unknown, ThrowOnError>

StaticgetMediaByIdAuditLog

Type Parameters

Parameters

Returns RequestResult<PagedAuditLogResponseModel, unknown, ThrowOnError>

StaticgetMediaByIdReferencedBy

Type Parameters

Parameters

Returns RequestResult<PagedIReferenceResponseModel, unknown, ThrowOnError>

StaticgetMediaByIdReferencedDescendants

Type Parameters

Parameters

Returns RequestResult<PagedReferenceByIdModel, unknown, ThrowOnError>

StaticgetMediaConfiguration

Type Parameters

Parameters

Returns RequestResult<MediaConfigurationResponseModel, unknown, ThrowOnError>

Deprecated

StaticgetMediaUrls

Type Parameters

Parameters

Returns RequestResult<MediaUrlInfoResponseModel[], unknown, ThrowOnError>

StaticgetRecycleBinMediaByIdOriginalParent

Type Parameters

Parameters

Returns RequestResult<ReferenceByIdModel, unknown, ThrowOnError>

StaticgetRecycleBinMediaChildren

Type Parameters

Parameters

Returns RequestResult<PagedMediaRecycleBinItemResponseModel, unknown, ThrowOnError>

StaticgetRecycleBinMediaReferencedBy

Type Parameters

Parameters

Returns RequestResult<PagedIReferenceResponseModel, unknown, ThrowOnError>

StaticgetRecycleBinMediaRoot

Type Parameters

Parameters

Returns RequestResult<PagedMediaRecycleBinItemResponseModel, unknown, ThrowOnError>

StaticgetTreeMediaAncestors

Type Parameters

Parameters

`Static`deleteMediaById

`Static`deleteRecycleBinMedia

`Static`deleteRecycleBinMediaById

`Static`getCollectionMedia

`Static`getItemMedia

`Static`getItemMediaSearch

`Static`getMediaAreReferenced

`Static`getMediaById

`Static`getMediaByIdAuditLog

`Static`getMediaByIdReferencedBy

`Static`getMediaByIdReferencedDescendants

`Static`getMediaConfiguration

`Static`getMediaUrls

`Static`getRecycleBinMediaByIdOriginalParent

`Static`getRecycleBinMediaChildren

`Static`getRecycleBinMediaReferencedBy

`Static`getRecycleBinMediaRoot

`Static`getTreeMediaAncestors

`Static`getTreeMediaChildren

`Static`getTreeMediaRoot

`Static`postMedia

`Static`postMediaValidate

`Static`putMediaById

`Static`putMediaByIdMove

`Static`putMediaByIdMoveToRecycleBin

`Static`putMediaByIdValidate

`Static`putMediaSort

`Static`putRecycleBinMediaByIdRestore