GetAuthorizationURL Method

Builds and returns the URL to which the user should be re-directed for authorization.

Syntax

oauth.getAuthorizationURL([callback])

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 this 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.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

When this method is called, the class will return the URL used for authorization. The class will not make any connections itself, but instead return the URL to you so that you may re-direct the user to this location. This is useful when ClientProfile is set to cfWebServer. Before calling this method set:

• ClientId
• ClientSecret
• ReturnURL
• AuthorizationScope (optional)