Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MediaVaultSettingsClient

Hierarchy

  • MediaVaultSettingsClient

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected apiClient

apiClient: ApiClient

Protected mediaVaultSettingsRoute

mediaVaultSettingsRoute: MediaVaultSettingsRoute

Accessors

routeDefinition

Methods

get

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

    method
    example

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

    Returns PromiseLike<IHttpResponse<IMediaVaultSettings>>

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

    method
    example

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

    Parameters

    • data: IMediaVaultSettings

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

    Returns PromiseLike<IHttpResponse<void>>

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

Generated using TypeDoc