The mailman-client API

0.1

A Node.js client for mailman-core

Preferences Class

Extends ApiRequest
Defined in: lib/Preferences.js:26
Module: Preferences
Parent Module: mailman-client

Preferences extends ApiRequest to do operations on the preferences resource

Properties

_keys Array private

Array of properties based on the Preferences _info object

Default: []

_options Object private

Inherited from BaseRequest but overwritten in lib/Preferences.js:39

Configuration options such as the endpoint of the API, auth parameters etc.

Default: {}

_params Object private

The object containing the query parameters

Default: {}

_path Object private

Object containing request path variables used to assemble the request URI (This will be overwritten by each of the child constructor classes i.e Client, List, etc.)

Default: {}

_preferences Object private

Object containing the resource information, will be null if getInfo() is never called

Default: null

_queryParams Boolean private

A boolean flag that is set when there are query parameters to be rendered

Default: false

_supportedMethods Array private

Inherited from BaseRequest but overwritten in lib/Preferences.js:49

Supported HTTP methods

Default: ['get','patch']

_template String private

Inherited from BaseRequest but overwritten in lib/Preferences.js:59

The URI template used to generate the URI to request

length Unknown

Length of the Preferences object

Default: 0

There are no properties that match your current filter settings. You can change your filter settings in the index section on this page. index

Constructor

Preferences
(
  • options
  • template
)

Parameters:

  • options Object

    A hash of options for the Settings instance

    • endpoint String

      The endpoint URI to request

    • [username] String optional

      A username for authenticating API requests

    • [password] String optional

      A password for authenticating API requests

  • template String

    The URI template used to generate the URI to request

Methods

_auth () Object private

Performs auth on the superagent request object if implied externally

Returns:

Object:

The superagent request object by performing auth on it

_checkAuthParameters () Boolean private

Checks if authentication is externally forced on the request object by passing in username & password

Returns:

Boolean:

Returns true if auth is forced else false

_checkMethodSupport
(
  • method
)
Boolean private

Verify that the request object in use supports a HTTP method

Parameters:

  • method String

    An HTTP method to check ('get', 'post', etc)

Returns:

Boolean:

Returns true if the HTTP method is supported else it will throw

_renderPath () String private

Renders the request path by using _path and _template

Returns:

String:

The rendered path string

_renderQuery () String private

Compose query string by using the recorded query parameters

Returns:

String:

Returns the query string to be appended in the final URI

_renderURI () String private

Renders the URI to request after checking for query parameters

Returns:

String:

The URI enpoint to request

_setAccessors () private

Set the accessors on the object for the resource information i.e _info object

_setPreferences () private

Nice little helping function for setting the _preferences from the data fetched from the server

delete
(
  • [callback]
  • transform
)
Promise async

Parameters:

  • [callback] Function optional

    A callback to invoke with the results of the DELETE request

    • err Error | Object

      Any errors encountered during the request

    • result Object

      The response of the request

  • transform String

    Flag to get the full response object by passing in identity

Returns:

Promise:

A promise to the results of the HTTP request

get
(
  • [callback]
  • transform
)
Promise async

Parameters:

  • [callback] Function optional

    A callback to invoke with the results of the GET request

    • err Error | Object

      Any errors encountered during the request

    • result Object

      The response of the request

  • transform String

    Flag to get the full response object by passing in identity

Returns:

Promise:

A promise to the results of the HTTP request

getPreferences
(
  • [callback]
)
Promise async

Fetch the resource by making a HTTP GET request and calls the callback(if any), and provide a promise to the Preferences object itself

Parameters:

  • [callback] Function optional

    The callback function to be invoked with the results

    • err Error | Object

      Any errors encountered during the request

    • result Object

      The Preferences object itself

Returns:

Promise:

Promise to the Preferences object itself

head
(
  • [callback]
  • transform
)
Promise async

Parameters:

  • [callback] Function optional

    A callback to invoke with the results of the HEAD request

    • err Error | Object

      Any errors encountered during the request

    • result Object

      The response of the request

  • transform String

    Flag to get the full response object by passing in identity

Returns:

Promise:

A promise to the results of the HTTP request

keys
(
  • [callback]
)
Promise async

Collect the keys of Preferences object in an array if _preferences is present

Parameters:

  • [callback] Function optional

    The callback function to be invoked with the results

    • err Error | Object

      Any errors encountered during the request

    • result Object

      An array of preferences fields

Returns:

Promise:

Promise to the array of preferences fields

patch
(
  • data
  • [callback]
  • transform
)
Promise async

Parameters:

  • data Object

    The patch data

  • [callback] Function optional

    A callback to invoke with the results of the PATCH request

    • err Error | Object

      Any errors encountered during the request

    • result Object

      The response of the request

  • transform String

    Flag to get the full response object by passing in identity

Returns:

Promise:

A promise to the results of the HTTP request

post
(
  • data
  • [callback]
  • transform
)
Promise async

Parameters:

  • data Object

    The post data

  • [callback] Function optional

    A callback to invoke with the results of the POST request

    • err Error | Object

      Any errors encountered during the request

    • result Object

      The response of the request

  • transform String

    Flag to get the full response object by passing in identity

Returns:

Promise:

A promise to the results of the HTTP request

put
(
  • data
  • [callback]
  • transform
)
Promise async

Parameters:

  • data Object

    The put data

  • [callback] Function optional

    A callback to invoke with the results of the PUT request

    • err Error | Object

      Any errors encountered during the request

    • result Object

      The response of the request

  • transform String

    Flag to get the full response object by passing in identity

Returns:

Promise:

A promise to the results of the HTTP request

query
(
  • key
  • [value]
)
Object chainable

Record query parameters to be rendered in the final URI

Parameters:

  • key String | Object

    The name of the query parameter or an object containing query parameters as key,val pairs repectively

  • [value] String | Array optional

    If the supplied key is a String, then value can be of type Array or String

Returns:

Object:

Returns the ApiRequest instance itself if the arguments are in the required form else throw an Error

save
(
  • [callback]
)
Promise async

Save the preferences upstream

Parameters:

  • [callback] Function optional

    The callback function to be invoked with the results

    • err Error | Object

      Any errors encountered during the request

    • result Object

      The Preferences object itself

Returns:

Promise:

Promise to the Preferences object itself

toString () String

String representation of the Preferences object

Returns:

String:

Returns the string representation of the Preferences object

There are no methods that match your current filter settings. You can change your filter settings in the index section on this page. index