Class Setup

Bluestep's Implementation of the OAuth workflow. Used to prime and then execute an OAuth transaction

Hierarchy

BaseSetup
- Setup

Index

Constructors

constructor

Methods

authorizationCodeFlow dataStoreFactory flow requestInitializer scope tokenRequestFlow

Constructors

constructor

new Setup(): Bluestep.Net.OAuth.Flows.Code.Auth.Setup
Returns Bluestep.Net.OAuth.Flows.Code.Auth.Setup
Inherited from BaseSetup.constructor

Methods

authorizationCodeFlow

authorizationCodeFlow(): AuthorizationCodeFlow
Returns the google client AuthorizationCodeFlow for custom control over the flow.

Returns AuthorizationCodeFlow
Inherited from BaseSetup.authorizationCodeFlow
- Defined in B.d.ts:1137

dataStoreFactory

dataStoreFactory(dataStoreFactory): Bluestep.Net.OAuth.Flows.Code.Auth.Setup
Set the dataStoreFactory.
Parameters
- dataStoreFactory: DataStoreFactory
Returns Bluestep.Net.OAuth.Flows.Code.Auth.Setup
Inherited from BaseSetup.dataStoreFactory
- Defined in B.d.ts:1126

flow

flow(user): Bluestep.Net.OAuth.Flows.Code.Auth.Flow
Returns a user flow using a [[Bluestep.User]].
Parameters
- user: User
Returns Bluestep.Net.OAuth.Flows.Code.Auth.Flow
- Defined in B.d.ts:1494
flow(userId): Bluestep.Net.OAuth.Flows.Code.Auth.Flow
Returns a user flow using a userId
Parameters
- userId: string
Returns Bluestep.Net.OAuth.Flows.Code.Auth.Flow
- Defined in B.d.ts:1500

requestInitializer

requestInitializer(requestInitializer): Bluestep.Net.OAuth.Flows.Code.Auth.Setup
Set the requestInitializer.
Parameters
- requestInitializer: ((request) => void)
  See https://googleapis.dev/java/google-http-client/latest/index.html?com/google/api/client/http/HttpRequest.html
  - - (request): void
    - Parameters
      request: Bluestep.Net.OAuth.HttpRequest
      Returns void
Returns Bluestep.Net.OAuth.Flows.Code.Auth.Setup
Inherited from BaseSetup.requestInitializer
- Defined in B.d.ts:1132

scope

scope(scope): Bluestep.Net.OAuth.Flows.Code.Auth.Setup
Set the scope.
Parameters
- scope: string[]
Returns Bluestep.Net.OAuth.Flows.Code.Auth.Setup
Inherited from BaseSetup.scope
- Defined in B.d.ts:1120

tokenRequestFlow

tokenRequestFlow(user, code): TokenRequestFlow
Returns a Token Request flow using a [[Bluestep.User]] and code.
Parameters
- user: User
- code: string
Returns TokenRequestFlow
- Defined in B.d.ts:1507
tokenRequestFlow(userId, code): TokenRequestFlow
Returns a Token Request flow using a code and user
Parameters
- userId: string
- code: string
Returns TokenRequestFlow
- Defined in B.d.ts:1514

Class Setup

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns Bluestep.Net.OAuth.Flows.Code.Auth.Setup

Methods

authorizationCodeFlow

Returns AuthorizationCodeFlow

dataStoreFactory

Parameters

dataStoreFactory: DataStoreFactory

Returns Bluestep.Net.OAuth.Flows.Code.Auth.Setup

flow

Parameters

user: User

Returns Bluestep.Net.OAuth.Flows.Code.Auth.Flow

Parameters

userId: string

Returns Bluestep.Net.OAuth.Flows.Code.Auth.Flow

requestInitializer

Parameters

requestInitializer: ((request) => void)

Parameters

request: Bluestep.Net.OAuth.HttpRequest

Returns void

Returns Bluestep.Net.OAuth.Flows.Code.Auth.Setup

scope

Parameters

scope: string[]

Returns Bluestep.Net.OAuth.Flows.Code.Auth.Setup

tokenRequestFlow

Parameters

user: User

code: string

Returns TokenRequestFlow

Parameters

userId: string

code: string

Returns TokenRequestFlow

Settings

Member Visibility

Theme

On This Page