Authorization Property
An OAuth Authorization String.
Syntax
gmail.getAuthorization([callback]) gmail.setAuthorization( authorization, [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 getAuthorization([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 setAuthorization([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 is used to specify an OAuth authorization string. Setting it is a requirement for using the component.
Example
Oauth oauth = new Oauth(); oauth.ClientId = "3c65828c-6376-4286-91b5-2381c3904a97"; oauth.ClientSecret = "mkk2a2M-B5TQI7o5p_N0fR-CHYVn7e3yH~"; oauth.ServerAuthURL = "https://accounts.google.com/o/oauth2/auth"; oauth.ServerTokenURL = "https://accounts.google.com/o/oauth2/token"; oauth.AuthorizationScope = "https://www.googleapis.com/auth/gmail.readonly"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; gmail.Authorization = oauth.GetAuthorization();
This property is not available at design time.
Data Type
String