Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OAuth2

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Optional accessToken

accessToken: AccessToken

config

config: Config

dedupe

dedupe: Function = ...

Protected logger

logger: Logger

storage

storage: CookieStorage | LocalStorage | SessionStorage

Protected url

url: (base: string, params?: {}) => string = ...

Type declaration

    • (base: string, params?: {}): string

    • Creates a url with the given query parameters

      Parameters

      • base: string

        the base url without query parameters

      • Optional params: {}

        the query parameters to attache to the url

        • [key: string]: any

      Returns string

      the built url

Accessors

$name

  • get $name(): string

code

  • get code(): string

key

  • get key(): string

  • Returns a scoped key for storage.

    example

    auth0.key('hello') // 'salte.auth.provider.auth0.hello'

    Returns string

login

  • get login(): string

logout

  • get logout(): string

name

  • get name(): string

Methods

$login

$validate

connected

  • connected(): void

emit

  • emit(name: string, ...args: any[]): void

off

  • off(name: string, listener: Function): void

on

  • on(name: "login", listener: (error?: Error, accessToken?: AccessToken) => void): void
  • on(name: "login", listener: (error?: Error, code?: string) => void): void
  • on(name: "logout", listener: (error?: Error) => void): void

redirectUrl

  • redirectUrl(type: "login" | "logout"): string

Protected required

  • required(...keys: string[]): void

secure

sync

  • sync(): void

validate

Protected validation

  • validation(key: string): boolean

  • Determines if validation is enabled for the given key.

    Parameters

    • key: string

      the key to determine whether validation is enabled for

    Returns boolean

    whether validation is enabled for the key.

Generated using TypeDoc