Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ApplicationSettingsClient

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected apiClient

apiClient: ApiClient

Protected applicationSettingsRoute

applicationSettingsRoute: ApplicationSettingsRoute

Accessors

routeDefinition

  • Provides direct access to applicationSettingsRoute.

    method
    example

    ApplicationSettingsClient.routeDefinition.get(options)

    Returns ApplicationSettingsRoute

Methods

get

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

    method
    example

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

    Parameters

    • options: IOptions

      Query resource options object.

    Returns PromiseLike<IHttpResponse<IApplication>>

update

  • Returns a promise that is resolved once the update application settings action has been performed. This action updates the application setting resource. This route uses HAL enabled objects to obtain routes and therefore it doesn't use applicationSettingsRoute route template. Here is an example of how a route can be obtained from HAL enabled objects:

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

    // appSettings is a resource previously fetched using get action. appSettings.allowAnyOrigin = true; applicationSettingsClient.update(appSettings) .then(function (data) { // perform success action here }, function (response, status, headers, config) { // perform error handling here });

    Parameters

    • data: IApplication

      An application object used to update application settings of the specified application resource.

    Returns PromiseLike<IHttpResponse<void>>

Generated using TypeDoc