Cloud Storage Integrator - Online Help
Cloud Storage Integrator
Questions / Feedback?

AccessToken Property

The access token returned by the authorization server.

Syntax

 oauth.getAccessToken([callback])
 oauth.setAccessToken( accessToken, [callback])

Default Value

""


Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getAccessToken([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setAccessToken([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property will be populated with the access token returned by the authorization server after a call to GetAuthorization. This will be the raw access token, whereas the return value from the GetAuthorization method will also include the required data so it can be passed directly to the Authorization property of the components or added as the value of the Authorization header in another client implementation.

Data Type

String

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 1.0.6240.0