Cloud Keys 2020 Node.js Edition

Questions / Feedback?

ReturnURL Property

The URL where the user (browser) returns after authenticating.

Syntax

 oauth.getReturnURL([callback])
 oauth.setReturnURL( returnURL, [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 getReturnURL([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 setReturnURL([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 cfApplication this will be automatically set to the address of the local embedded web server. In that case this property can be inspected to determine the URL where the user will be redirected, but does not need to be set.

When calling GetAuthorizationURL, which is common when ClientProfile is set to cfWebBrowser, set this property to the URL on your server where the user will be redirected after authenticating with the authorization server.

Data Type

String

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