OAuth1 ActiveX Reference Documentation

OAuth1

Current Version: 9.5.0.73

OAuth 1.0a signature generator.

Object Creation

(Visual Basic 6.0)
Dim obj As New ChilkatOAuth1

(ASP)
set obj = Server.CreateObject("Chilkat_9_5_0.OAuth1")

(VBScript)
set obj = CreateObject("Chilkat_9_5_0.OAuth1")

(Delphi)
obj := TChilkatOAuth1.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat_9_5_0.OAuth1')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.OAuth1")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.OAuth1', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.OAuth1");

Properties

AuthorizationHeader
AuthorizationHeader As String (read-only)
Introduced in version 9.5.0.53

The authorization header. This is what would be included in the Authorization HTTP request header if it is going to be used as the means for providing the OAuth1 authorization information.

top
BaseString
BaseString As String (read-only)
Introduced in version 9.5.0.53

This is the exact string that was signed. For example, if the signature method is HMAC-SHA1, the BaseString is the exact string that passed to the HMAC-SHA1. An application does not set the BaseString property. The BaseString is exposed as a property to allow for debugging and to see the exact string that is signed.

top
ConsumerKey
ConsumerKey As String
Introduced in version 9.5.0.53

The consumer key.

top
ConsumerSecret
ConsumerSecret As String
Introduced in version 9.5.0.53

The consumer secret.

top
DebugLogFilePath
DebugLogFilePath As String

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
EncodedSignature
EncodedSignature As String (read-only)
Introduced in version 9.5.0.53

The URL encoded representation of the Signature property

top
GeneratedUrl
GeneratedUrl As String (read-only)
Introduced in version 9.5.0.53

The URL that includes the OAuth1 query params.

top
HmacKey
HmacKey As String (read-only)
Introduced in version 9.5.0.53

The exact HMAC key used to sign the BaseString. An application does not directly set the HmacKey. The HmacKey property is read-only and is provided for debugging to see the exact HMAC key used to sign the BaseString. The HMAC key is composed from the consumer secret (if it exists) and the token secret (if it exists).

top
LastBinaryResult
LastBinaryResult As Variant (read-only)
Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

top
LastErrorHtml
LastErrorHtml As String (read-only)

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
LastErrorText As String (read-only)

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
LastErrorXml As String (read-only)

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
LastMethodSuccess As Long
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = 1 and failure = 0.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
LastStringResult
LastStringResult As String (read-only)
Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

top
LastStringResultLen
LastStringResultLen As Long (read-only)
Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

top
Nonce
Nonce As String
Introduced in version 9.5.0.53

The nonce.

top
OauthMethod
OauthMethod As String
Introduced in version 9.5.0.53

The HTTP method, such as "GET", "POST", "PUT", "DELETE", or "HEAD". Defaults to "GET".

top
OauthUrl
OauthUrl As String
Introduced in version 9.5.0.53

The OAuth URL, such as "http://echo.lab.madgex.com/echo.ashx". See http://bettiolo.github.io/oauth-reference-page/ to compare Chilkat results with another tool's results.

Note: The OAuthUrl should not include query parameters. For example, do not set the OAuthUrl equal to

https://rest.sandbox.netsuite.com/app/site/hosting/restlet.nl?script=165&deploy=1
Instead, set OAuthUrl equal to
https://rest.sandbox.netsuite.com/app/site/hosting/restlet.nl
and then subsequently call AddParam for each query parameter.

top
OauthVersion
OauthVersion As String
Introduced in version 9.5.0.53

The oauth_version. Defaults to "1.0". May be set to the empty string to exclude.

top
QueryString
QueryString As String (read-only)
Introduced in version 9.5.0.53

Contains the normalized set of request parameters that are signed. This is a read-only property made available for debugging purposes.

top
Realm
Realm As String
Introduced in version 9.5.0.70

The realm (optional).

top
Signature
Signature As String (read-only)
Introduced in version 9.5.0.53

The generated base64 signature.

top
SignatureMethod
SignatureMethod As String
Introduced in version 9.5.0.53

The signature method. Defaults to "HMAC-SHA1". Other possible choices are "HMAC1-SHA256", "RSA-SHA1", and "RSA-SHA2".

top
Timestamp
Timestamp As String
Introduced in version 9.5.0.53

The timestamp, such as "1441632569".

top
Token
Token As String
Introduced in version 9.5.0.53

The token.

top
TokenSecret
TokenSecret As String
Introduced in version 9.5.0.53

The token secret

top
VerboseLogging
VerboseLogging As Long

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
Version As String (read-only)

Version of the component/library, such as "9.5.0.63"

top

Methods

AddParam
AddParam(name As String, value As String) As Long
Introduced in version 9.5.0.53

Adds an extra name/value parameter to the OAuth1 signature.

Returns 1 for success, 0 for failure.

top
Generate
Generate() As Long
Introduced in version 9.5.0.53

Generate the signature based on the property settings. Input properties are OauthVersion, OauthMethod, Url, ConsumerKey, ConsumerSecret, Token, TokenSecret, Nonce, and Timestamp. Properties set by this method include: BaseString, Signature, HmacKey, EncodedSignature, QueryString, GeneratedUrl, andAuthorizationHeader.

Returns 1 for success, 0 for failure.

top
GenNonce
GenNonce(ByVal numBytes As Long) As Long
Introduced in version 9.5.0.55

Generates a random nonce numBytes in length and sets the Nonce property to the hex encoded value.

Returns 1 for success, 0 for failure.

top
GenTimestamp
GenTimestamp() As Long
Introduced in version 9.5.0.55

Sets the Timestamp property to the current date/time.

Returns 1 for success, 0 for failure.

top
RemoveParam
RemoveParam(name As String) As Long
Introduced in version 9.5.0.53

Removes a name/value parameter from the OAuth1 signature.

Returns 1 for success, 0 for failure.

top
SetRsaKey
SetRsaKey(privKey As PrivateKey) As Long
Introduced in version 9.5.0.64

Sets the RSA key to be used when the SignatureMethod is set to "RSA-SHA1" or "RSA-SHA2".

Returns 1 for success, 0 for failure.

top