Fork me on GitHub

Class request.AuthenticatedXmlRequest


Extends request.AuthenticatedRequest.

Defined in: request.js.

Class Summary
Constructor Attributes Constructor Name and Description
 

Authenticated request wrapper class with JSON results (from XML).

Method Summary
Method Attributes Method Name and Description
 
processResults(data, response)
Methods borrowed from class request.Request:
end
Events borrowed from class request.Request:
end, error
Class Detail
request.AuthenticatedXmlRequest(auth, options)

Authenticated request wrapper class with JSON results (from XML).

Note: Accumulates data for final 'end' event instead of passing through via typical 'data' events.

Parameters:
{base.Authentication} auth
Authentication object.
{Object} options
Options object.
{string} options.method Optional
HTTP method (verb).
{string} options.path Optional
HTTP path.
{Object} options.headers Optional
HTTP headers.
{Object} options.cloudHeaders Optional
Cloud provider headers to add.
{Object} options.metadata Optional
Cloud metadata to add.
{Function} options.errorFn Optional
errorFn(err, request, [response]) Error handler (if return True, no further error handling takes place).
{Function} options.resultsFn Optional
resultsFn(results, request, [response]) Successful results data transform.
Method Detail
processResults(data, response)
Parameters:
data
response
See:
request.AuthenticatedXmlRequest#processResults