Bluestep JS Documentation
    Preparing search index...

    Class Flow

    TODO

    TODO

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    addToState authorizationCodeCallback authorize codeCallback credentials errors notAuthorized oauthCodeSetup provider redirectUrlOverride user

    Constructors

    Methods

    • By default the state will include a csrf value that is stored in the as json object as well as the session in order to prevent cross site request forgery. You may use this method to add additional members to the state json object.

      Parameters

      • key: string
      • value: any

      Returns this

    • Overrides the default oauth behavior to hand back the redirect to your callback rather than do the redirect for you; handy when custom behavior is desired, or when you simply wish to use the endpoint that is calling this as a proxy

      Parameters

      • authorizationCodeCallback: (url: string) => void

      Returns this

      // this is the default behavior if this is not called
        B.net.oauth.flows.code.relateData.flow()
          .provider(provider)
          .addToState("action", action)
          .addToState("provider", provider)
          .authorizationCodeCallback(
            // THIS IS THE `DEFAULT BEHAVIOR`
            url => B.net.response.redirect(url)
          )
          .authorize();

      // this is a potential other implementation
        B.net.oauth.flows.code.relateData.flow()
          .provider(provider)
          .addToState("action", action)
          .addToState("provider", provider)
          .authorizationCodeCallback(
            url => {
              formEntry.fields.savedAuthUrl.val(url);
              B.net.response.out(url);
            }
          )
          .authorize();

    • Start the authorization process

      Returns void

    • TODO

      Parameters

      Returns this

    • This callback gets called after authorization is successful. Required for all OAuth flows.

      Parameters

      Returns this

    • This callback gets called for errors. The default actions is:

      throw new OAuthException(errorMssg);`

      Parameters

      Returns this

    • Callback when the code is not authorized.

      Parameters

      • notAuthorizedFnc: (msg: string) => void

      Returns this

    • Use this method if you need to add to the oauthSetup before calling authorize

      Returns BaseSetup

    • Use this redirect Url instead of the one suggested by the relate provider entry.

      Parameters

      • urlRedirectOverride: string

      Returns this

    • The OAuth User to use. If userRelateDataStore is false the credentials will be stored in the session.

      Parameters

      • userId: string
      • userRelateDataStore: boolean

      Returns this

    • The OAuth User to use. If the user is not provided, or isn't a user, or doesn't have relate data (e.g. a super user) then credentials will be stored in the session.

      Parameters

      Returns this

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods