EngineAuthService | @acaengine/ts-client

Hierarchy

EngineAuthService

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new EngineAuthService(options: EngineAuthOptions): EngineAuthService

- Defined in auth/auth.service.ts:39
Parameters
- options: EngineAuthOptions
Returns EngineAuthService

Accessors

api_endpoint

get api_endpoint(): string

- Defined in auth/auth.service.ts:57
API Endpoint for the retrieved version of engine

Returns string

authority

get authority(): EngineAuthority | undefined

- Defined in auth/auth.service.ts:108
Engine Authority details

Returns EngineAuthority | undefined

client_id

get client_id(): string

- Defined in auth/auth.service.ts:75
OAuth 2 client ID for the application

Returns string

fixed_device

get fixed_device(): boolean

- Defined in auth/auth.service.ts:139
Whether this application is on a fixed location device

Returns boolean

has_token

get has_token(): boolean

- Defined in auth/auth.service.ts:103
Whether the application has an authentication token

Returns boolean

is_online

get is_online(): boolean

- Defined in auth/auth.service.ts:113
Whether engine is online

Returns boolean

online_state

get online_state(): Observable<boolean>

- Defined in auth/auth.service.ts:118
Observable for the online state of engine

Returns Observable<boolean>

redirect_uri

get redirect_uri(): string

- Defined in auth/auth.service.ts:80
Redirect URI for the OAuth flow

Returns string

refresh_token

get refresh_token(): string

- Defined in auth/auth.service.ts:98
Refresh token for renewing the access token

Returns string

route

get route(): "/api/engine/v2" | "/control/api"

- Defined in auth/auth.service.ts:63
Path of the API endpoint

Returns "/api/engine/v2" | "/control/api"

token

get token(): string

- Defined in auth/auth.service.ts:85
Bearer token for authenticating requests to engine

Returns string

trusted

get trusted(): boolean

- Defined in auth/auth.service.ts:123
Whether this application is trusted

Returns boolean

Methods

authorise

authorise(state?: undefined | string): Promise<string>

- Defined in auth/auth.service.ts:174
Check the users authentication credentials and perform actions required for the user to authenticate

Parameters
- Optional state: undefined | string
  
  Additional state information for auth requests
Returns Promise<string>

invalidateToken

invalidateToken(): void

- Defined in auth/auth.service.ts:165
Invalidate the current access token

Returns void

logout

logout(): void

- Defined in auth/auth.service.ts:241
Logout and clear user credentials for the application

Returns void

refreshAuthority

refreshAuthority(): void

- Defined in auth/auth.service.ts:157
Refresh authentication

Returns void

setup

setup(options: EngineAuthOptions): void

- Defined in auth/auth.service.ts:48
Parameters
- options: EngineAuthOptions
Returns void

Generated using TypeDoc