@auvious/common / AuviousCommon

Class: AuviousCommon

auvious client implementation for auvious' services.

The auvious client instance should be used as a hub for any auvious service client.

Table of contents

Constructors

• constructor

Properties

• _apiUserResource
• _authClient
• _eventClient
• _host
• _port
• _serverUrl
• _useStandardOAuth2
• log
• timers

Accessors

• auth
• events
• eventsEnabled
• eventsInitialized
• serverUrl
• user

Methods

• apiResourceFactory
• apiSearchResourceFactory
• delayUsingSetTimeout
• getTimers
• guestLogin
• login
• loginTemplate
• logout

Constructors

constructor

• new AuviousCommon(args): AuviousCommon

Constructor.

Parameters

Name	Type	Description
args	IAuviousClientArgs	constructor options

Returns

AuviousCommon

Properties

_apiUserResource

• Private _apiUserResource: ApiUserResource

---

_authClient

• Private _authClient: OAuth2Client

---

_eventClient

• Private _eventClient: AuviousEventClient

---

_host

• Private _host: string

---

_port

• Private _port: number

---

_serverUrl

• Private _serverUrl: string

---

_useStandardOAuth2

• Private _useStandardOAuth2: boolean = false

---

log

• Private log: Logger

---

timers

• Private timers: Timers

Accessors

auth

• get auth(): OAuth2Client

Gets the authentication resource instance (OAuth2Client).

Returns

OAuth2Client

---

events

• get events(): AuviousEventClient

Gets the event client instance (EventClient).

Returns

AuviousEventClient

---

eventsEnabled

• get eventsEnabled(): boolean

Gets whether or not the event client is enabled.

Returns

boolean

---

eventsInitialized

• get eventsInitialized(): boolean

Returns

boolean

---

serverUrl

• get serverUrl(): string

Gets the server url. The http host the client targets.

Returns

string

---

user

• get user(): ApiUserResource

Returns

ApiUserResource

Methods

apiResourceFactory

▸ apiResourceFactory(route): ApiResource

Parameters

Name	Type
route	string

Returns

ApiResource

---

apiSearchResourceFactory

▸ apiSearchResourceFactory(route, searchType): ApiSearchResource

Parameters

Name	Type
route	string
searchType	any

Returns

ApiSearchResource

---

delayUsingSetTimeout

▸ delayUsingSetTimeout(ms): Promise<void>

Parameters

Name	Type
ms	number

Returns

Promise<void>

---

getTimers

▸ getTimers(): Timers

Returns

Timers

---

guestLogin

▸ guestLogin(username, clientId?, organization?): Promise<IOAuth2Token>

Guest Login. Will this ever be used? I don't know.

Parameters

Name	Type	Description
username	string	username
clientId?	string	-
organization?	string	-

Returns

Promise<IOAuth2Token>

---

login

▸ login(username, password, clientId?, organization?): Promise<IOAuth2Token>

Login at it's purest form.

Parameters

Name	Type	Description
username	string	username
password	string	password
clientId?	string	-
organization?	string	-

Returns

Promise<IOAuth2Token>

---

loginTemplate

▸ loginTemplate(tokenProviderFn, refreshTokenProviderFn?): Promise<IOAuth2Token>

Parameters

Name	Type
tokenProviderFn	() => Promise<IJwtTokenResponse>
refreshTokenProviderFn?	(refreshToken: string) => Promise<IJwtTokenResponse>

Returns

Promise<IOAuth2Token>

---

logout

▸ logout(): Promise<void>

Logout.

Returns

Promise<void>