Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MediaVaultClient

Hierarchy

  • MediaVaultClient

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected apiClient

apiClient: ApiClient

Protected mediaVaultBatchClient

mediaVaultBatchClient: MediaVaultBatchClient

Protected mediaVaultProcessingProviderSettingsClient

mediaVaultProcessingProviderSettingsClient: MediaVaultProcessingProviderSettingsClient

Protected mediaVaultRoute

mediaVaultRoute: MediaVaultRoute

Protected mediaVaultSettingsClient

mediaVaultSettingsClient: MediaVaultSettingsClient

Protected mediaVaultStreamsClient

mediaVaultStreamsClient: MediaVaultStreamsClient

Accessors

batch

processingProviderSettings

routeDefinition

  • Returns MediaVaultRoute

settings

streams

Methods

find

  • Returns a promise that is resolved once the find action has been performed. Success response returns a list of media vault resources matching the given criteria.

    method
    example

    mediaVaultClient.find({ pageNumber : 1, pageSize : 10, orderBy : '', orderDirection : '', search : '' }) .then(function (collection) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    Parameters

    • Optional options: IOptions

      Query resource options object.

    Returns PromiseLike<IHttpResponse<IQueryModel<IMediaEntry>>>

    A promise that is resolved once the find action has been performed.

get

  • Returns a promise that is resolved once the get action has been performed. Success response returns requested media vault resource.

    method
    example

    mediaVaultClient.get('') .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    Parameters

    • id: string

      Media vault id which uniquely identifies media vault resource that needs to be retrieved.

    • Optional options: IGetRequestOptions

      Query resource options object.

    Returns PromiseLike<IHttpResponse<IMediaEntry>>

    A promise that is resolved once the get action has been performed.

remove

  • Returns a promise that is resolved once the remove action has been performed. This action will remove one or many media vault resources from the system if successfully completed. If derived resource's format is passed, such as width and height for the image type of media vault resource, the operation will remove just derived resource. Otherwise, specified media vault and all its accompanying derived resources will be removed from the system. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply baasicMediaVaultRouteService route template. Here is an example of how a route can be obtained from HAL enabled objects:

    let params = modelMapper.removeParams(mediaVaultEntry);
let uri = params['model'].links('delete').href;
    method
    example

    // mediaVaultEntry is a media vault resource previously fetched using get action. The following action will remove the original media vault resource and all accompanying derived media vault resources. mediaVaultClient.remove(mediaVaultEntry) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here }); // mediaVaultEntry is a media vault resource previously fetched using get action. The following action will remove derived media vault resource only. mediaVaultClient.remove(mediaVaultEntry, {width: , height: }) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    Parameters

    • data: IMediaEntry

      Media vault object used to delete specific Media vault resource from the system.

    • options: Object

      Options object.

    Returns PromiseLike<IHttpResponse<void>>

update

  • Returns a promise that is resolved once the update media vault action has been performed; this action will update a media vault resource if successfully completed. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply mediaVaultRoute route template. Here is an example of how a route can be obtained from HAL enabled objects:

    let params = modelMapper.updateParams(mediaVaultEntry);
let uri = params['model'].links('put').href;
    method
    example

    // mediaVaultEntry is a media vault resource previously fetched using get action. mediaVaultEntry.description = ''; mediaVaultClient.update(mediaVaultEntry) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    Parameters

    • data: IMediaEntry

      A media vault object used to update specified media vault resource.

    Returns PromiseLike<IHttpResponse<void>>

    A promise that is resolved once the update media vault action has been performed.

Generated using TypeDoc