Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • MediaVaultBatchClient

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected apiClient

apiClient: ApiClient

Protected mediaVaultBatchRoute

mediaVaultBatchRoute: MediaVaultBatchRoute

Accessors

routeDefinition

Methods

remove

  • Returns a promise that is resolved once the remove action has been performed. This action will remove 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.

    method
    example

    // Remove original media vault resources mediaVaultBatchClient.remove([{ id: '' }]) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here }); // Remove derived media vault resources mediaVaultBatchClient.remove([{ id: '', fileFormat: { width: , height: } }]) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    Parameters

    • data: any[]

      Collection of media vault delete requests which uniquely identifies media vault resources that need to be deleted.

    Returns PromiseLike<IHttpResponse<void>>

update

  • Returns a promise that is resolved once the update action has been performed; this action updates specified media vault resources.

    method
    example

    mediaVaultStreamsClient.update(files) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    Parameters

    • data: IMediaEntry[]

      A collection of media vault objects used to update specified media vault resources.

    Returns PromiseLike<IHttpResponse<void>>

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

Generated using TypeDoc