Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Metrics

Hierarchy

  • Metrics

Index

Constructors

constructor

Accessors

core

onConnectionChangeEvent

onDisposeEvent

  • get onDisposeEvent(): ISimpleEvent<void>

persistConnection

  • get persistConnection(): boolean

socketConnected

  • get socketConnected(): boolean

Methods

action

  • action(action: string, params?: Object): Promise<unknown>
  • Parameters

    • action: string
    • Default value params: Object = {}

    Returns Promise<unknown>

authenticateWithCredentials

  • authenticateWithCredentials(params: { email: string; password: string; refreshable?: undefined | false | true }): Promise<UserSession>
  • Parameters

    • params: { email: string; password: string; refreshable?: undefined | false | true }
      • email: string
      • password: string
      • Optional refreshable?: undefined | false | true

    Returns Promise<UserSession>

authenticateWithFacebook

  • authenticateWithFacebook(params: { redirect: string }): Promise<string>
  • Parameters

    • params: { redirect: string }
      • redirect: string

    Returns Promise<string>

authenticateWithGoogle

  • authenticateWithGoogle(params: { redirect: string }): Promise<string>
  • Parameters

    • params: { redirect: string }
      • redirect: string

    Returns Promise<string>

authenticateWithResetToken

  • authenticateWithResetToken(params: { password: string; refreshable?: undefined | false | true; resetToken: string }): Promise<UserSession>
  • Parameters

    • params: { password: string; refreshable?: undefined | false | true; resetToken: string }
      • password: string
      • Optional refreshable?: undefined | false | true
      • resetToken: string

    Returns Promise<UserSession>

authenticateWithToken

  • authenticateWithToken(params: { token: string }): Promise<UserSession>

createUser

  • createUser(params: { email: string; password: string; refreshable?: undefined | false | true }): Promise<UserSession>
  • Parameters

    • params: { email: string; password: string; refreshable?: undefined | false | true }
      • email: string
      • password: string
      • Optional refreshable?: undefined | false | true

    Returns Promise<UserSession>

dispose

  • dispose(): void

passwordReset

  • passwordReset(params: { email: string }): Promise<void>
  • Parameters

    • params: { email: string }
      • email: string

    Returns Promise<void>