Cloud Mail 2020 Node.js Edition

Questions / Feedback?

AuthorizationCode Property

The authorization code that is exchanged for an access token.

Syntax

 oauth.getAuthorizationCode([callback])
 oauth.setAuthorizationCode( authorizationCode, [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 getAuthorizationCode([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 setAuthorizationCode([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

When ClientProfile is set to cfWebServer (WebServer flow) the authorization server will return a code when the user is re-directed from the authorization server back to your website. This code is returned as a query string parameter and the class will automatically populate this property with that value.

Normally this property will only be informational, as the GetAuthorization method will automatically exchange this code for a token with the authorization server specified in ServerTokenURL.

If this property is set before calling GetAuthorization the class will attempt to exchange the code with the authorization server for an access token.

This property is not available at design time.

Data Type

String

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
Cloud Mail 2020 Node.js Edition - Version 20.0 [Build 7718]