Skip to main content
Version: 2025.2

OAuthConfig

Configuration Object for OAuth.

Methods​

consumerKey​

consumerKey(pConsumerKey): OAuthConfig

Sets the consumer key.

Parameters​

pConsumerKey
string | number | boolean

the consumer key

Returns​

OAuthConfig

OAuthConfig


consumerSecret​

consumerSecret(pConsumerSecret): OAuthConfig

Sets the consumer secret.

Parameters​

pConsumerSecret
string | number | boolean

the consumer secret

Returns​

OAuthConfig

OAuthConfig


getConsumerKey​

getConsumerKey(): string

Returns the consumer key.

Returns​

string

the consumer key


getConsumerSecret​

getConsumerSecret(): string

Returns the consumer secret.

Returns​

string

the consumer secret


getNonce​

getNonce(): string

Returns the nonce.

Returns​

string

the nonce


getRealm​

getRealm(): string

Returns the authorization realm.

Returns​

string

the realm


getSignatureMethod​

getSignatureMethod(): string

Returns the signature method.

Returns​

string

the signature method


getTimeStamp​

getTimeStamp(): string

Returns the timestamp.

Returns​

string

timestamp


getToken​

getToken(): string

Returns the OAuth token.

Returns​

string

the token


getTokenSecret​

getTokenSecret(): string

Returns the toke secret.

Returns​

string

the toke secret


getVersion​

getVersion(): string

Returns the version.

Returns​

string

the version


nonce​

nonce(pNonce): OAuthConfig

Sets the nonce.

Parameters​

pNonce
string | number | boolean

the nonce

Returns​

OAuthConfig

OAuthConfig


realm​

realm(pRealm): OAuthConfig

Sets the authorization realm.

Parameters​

pRealm
string | number | boolean

the realm

Returns​

OAuthConfig

OAuthConfig


signatureMethod​

signatureMethod(pSignatureMethod): OAuthConfig

Sets the signature method.

Parameters​

pSignatureMethod
string | number | boolean

the signature method.

Returns​

OAuthConfig

OAuthConfig


timeStamp​

timeStamp(pTimeStamp): OAuthConfig

Sets the timestamp.

Parameters​

pTimeStamp
string | number | boolean

the timestamp

Returns​

OAuthConfig

OAuthConfig


token​

token(pToken): OAuthConfig

Sets the OAuth token.

Parameters​

pToken
string | number | boolean

the token

Returns​

OAuthConfig

OAuthConfig


tokenSecret​

tokenSecret(pTokenSecret): OAuthConfig

Sets the token secret.

Parameters​

pTokenSecret
string | number | boolean

the token secret

Returns​

OAuthConfig

OAuthConfig


version​

version(pVersion): OAuthConfig

Sets the version.

Parameters​

pVersion
string | number | boolean

the version

Returns​

OAuthConfig

OAuthConfig