Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • MediaVaultProcessingProviderSettingsClient

Index

Constructors

constructor

Properties

Protected apiClient

apiClient: ApiClient

Protected mediaVaultProcessingProviderSettingsRoute

mediaVaultProcessingProviderSettingsRoute: MediaVaultProcessingProviderSettingsRoute

Accessors

routeDefinition

Methods

find

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

    method
    example

    mediaVaultProcessingProviderSettingsClient.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<IPreprocessingProviderSettings>>>

    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 the media vault processing provider resource.

    method
    example

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

    Parameters

    • id: string

      Preprocessing provider id which uniquely identifies preprocessing provider whose settings need to be retrieved.

    • Optional options: IGetRequestOptions

      Query resource options object.

    Returns PromiseLike<IHttpResponse<IPreprocessingProviderSettings>>

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

update

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

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

    // processingProviderSettings is a resource previously fetched using get action. processingProviderSettings.settings.faceDetection = true; mediaVaultProcessingProviderSettingsClient.update(processingProviderSetting) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    Parameters

    • data: IPreprocessingProviderSettings

      A media vault preprocessing provider settings object used to update specified media vault preprocessing provider settings in the system.

    Returns PromiseLike<IHttpResponse<void>>

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

Generated using TypeDoc