Class default

Hierarchy

default

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new default(options?: ConnectionOptions): default

- Defined in src/core.ts:38
Parameters
- options: ConnectionOptions = {}
Returns default

Accessors

core

get core(): Core

- Defined in src/core.ts:55
Returns Core

onConnectionChangeEvent

get onConnectionChangeEvent(): IEvent<ConnectionEvent>

- Defined in src/core.ts:67
Returns IEvent<ConnectionEvent>

onDisposeEvent

get onDisposeEvent(): IEvent<void>

- Defined in src/core.ts:43
Returns IEvent<void>

persistConnection

get persistConnection(): boolean

- Defined in src/core.ts:51
Returns boolean

socketConnected

get socketConnected(): boolean

- Defined in src/core.ts:47
Returns boolean

Methods

action

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

- Defined in src/core.ts:63
Parameters
- action: string
- params: Object = {}
Returns Promise<unknown>

authenticateWithCredentials

authenticateWithCredentials(params: { email: string; password: string; refreshable?: boolean }): Promise<UserSession>

- Defined in src/core.ts:86
deprecated

Parameters
- params: { email: string; password: string; refreshable?: boolean }
  - email: string
  - password: string
  - Optional refreshable?: boolean
Returns Promise<UserSession>

authenticateWithExchangeToken

authenticateWithExchangeToken(params: { exchangeToken: string }): Promise<UserSession>

- Defined in src/core.ts:80
Parameters
- params: { exchangeToken: string }
  - exchangeToken: string
Returns Promise<UserSession>

authenticateWithKioskToken

authenticateWithKioskToken(params: { kioskToken: string }): Promise<KioskSession>

- Defined in src/core.ts:102
Parameters
- params: { kioskToken: string }
  - kioskToken: string
Returns Promise<KioskSession>

authenticateWithMachineInitializerToken

authenticateWithMachineInitializerToken(params: { machineInitializerToken: string; strengthMachineIdentifier: StrengthMachineIdentifier }): Promise<StrengthMachineSession>

- Defined in src/core.ts:116
Parameters
- params: { machineInitializerToken: string; strengthMachineIdentifier: StrengthMachineIdentifier }
  - machineInitializerToken: string
  - strengthMachineIdentifier: StrengthMachineIdentifier
Returns Promise<StrengthMachineSession>

authenticateWithMachineToken

authenticateWithMachineToken(params: { machineToken: string; strengthMachineIdentifier: StrengthMachineIdentifier }): Promise<StrengthMachineSession>

- Defined in src/core.ts:107
Parameters
- params: { machineToken: string; strengthMachineIdentifier: StrengthMachineIdentifier }
  - machineToken: string
  - strengthMachineIdentifier: StrengthMachineIdentifier
Returns Promise<StrengthMachineSession>

authenticateWithToken

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

- Defined in src/core.ts:97
Parameters
- params: { token: string }
  - token: string
Returns Promise<UserSession>

authenticateWithWelcomeToken

authenticateWithWelcomeToken(params: { password: string; refreshable?: boolean; welcomeToken: string }): Promise<UserSession>

- Defined in src/core.ts:92
deprecated

Parameters
- params: { password: string; refreshable?: boolean; welcomeToken: string }
  - password: string
  - Optional refreshable?: boolean
  - welcomeToken: string
Returns Promise<UserSession>

dispose

dispose(): void

- Defined in src/core.ts:59
Returns void

generateSSORequestUrl

generateSSORequestUrl(requestParameters: SSORequestParameters, userParameters?: UserSSOParameters): Promise<URL>

- Defined in src/core.ts:71
Parameters
- requestParameters: SSORequestParameters
- Optional userParameters: UserSSOParameters
Returns Promise<URL>