Home Reference Source Test Repository
import OAuthConnectorBase from '@hoist/oauth-connector/src/oauth_connector.js'
protected class | source

OAuthConnectorBase

Constructor Summary

Protected Constructor
protected

constructor(configuration: object)

Method Summary

Public Methods
public

authorize(authorization: <AuthorizationStore>)

authorize the oauth connection with existing parameters
public

receiveBounce(authorization: AuthorizationStore): *

Protected Constructors

protected constructor(configuration: object) source

Params:

NameTypeAttributeDescription
configuration object

the configuration details for this connector

configuration.consumerKey string

the OAuth consumer key

configuration.consumerSecret string

the OAuth consumer secret

configuration.requestTokenUri string

the uri to use for request token calls

configuration.accessTokenUri string

the uri to use for access token calls

configuration.authorizationUri string

the uri to send users to authorise access

configuration.oauthVersion object
  • optional
  • default: 1.0A

the version of OAuth to use

configuration.signingMethod object
  • optional
  • default: HMAC-SHA1

the signing method to use

Public Methods

public authorize(authorization: <AuthorizationStore>) source

authorize the oauth connection with existing parameters

Params:

NameTypeAttributeDescription
authorization <AuthorizationStore>

the users authorization

public receiveBounce(authorization: AuthorizationStore): * source

Params:

NameTypeAttributeDescription
authorization AuthorizationStore

the users authorization

Return:

*