Class: Configuration

@acceleratxr/core_sdk / Configuration

Class: Configuration#

Hierarchy#

  • Configuration

Index#

Constructors#

Properties#

Methods#

Constructors#

constructor#

+ new Configuration(other?: any): Configuration

Defined in src/Configuration.ts:151

Parameters:#

Name

Type

other?

any

Returns: Configuration

Properties#

allowInsecure#

• allowInsecure: boolean = false

Defined in src/Configuration.ts:130

apiKeys#

• apiKeys: Map<string, string> = new Map()

Defined in src/Configuration.ts:139

authMethods#

• authMethods: AuthMethod[] = []

Defined in src/Configuration.ts:131

baseServicePaths#

• baseServicePaths: Map<any, string> = new Map()

Defined in src/Configuration.ts:140

baseUrl#

• baseUrl: string = “http://localhost:3000”

Defined in src/Configuration.ts:132

bustCache#

• bustCache: boolean = true

Defined in src/Configuration.ts:133

cacheTTL#

• cacheTTL: number = 30

Defined in src/Configuration.ts:134

deviceId#

• deviceId: string = uuid.v4()

Defined in src/Configuration.ts:135

jwtAudience#

• jwtAudience: string = “mydomain.com”

Defined in src/Configuration.ts:136

jwtIssuer#

• jwtIssuer: string = “api.mydomain.com”

Defined in src/Configuration.ts:137

jwtPassword#

• jwtPassword: string = “PASSWORD”

Defined in src/Configuration.ts:138

loggedInUser#

• loggedInUser: User | undefined = undefined

Defined in src/Configuration.ts:141

maxRetries#

• maxRetries: number = 5

Defined in src/Configuration.ts:144

passwordConfig#

• passwordConfig: PasswordConfig

Defined in src/Configuration.ts:147

pollingFrequency#

• pollingFrequency: number = 5000

Defined in src/Configuration.ts:142

proxyUrl#

• proxyUrl: string = “”

Defined in src/Configuration.ts:143

sdkClientApp#

• sdkClientApp: string = “ClientApp”

Defined in src/Configuration.ts:150

sdkClientName#

• sdkClientName: string = “nodejs-sdk”

Defined in src/Configuration.ts:149

sdkClientVersion#

• Private sdkClientVersion: string = “0.0.0”

Defined in src/Configuration.ts:151

trustedRoles#

• trustedRoles: Array<string> = [“admin”]

Defined in src/Configuration.ts:145

useAuthHeader#

• useAuthHeader: boolean = false

Defined in src/Configuration.ts:146

userRequiredProps#

• userRequiredProps: UsersRequiredProps

Defined in src/Configuration.ts:148

Methods#

clearApiKey#

▸ clearApiKey(prefix: string): void

Defined in src/Configuration.ts:423

Parameters:#

Name

Type

prefix

string

Returns: void

clearApiKeys#

▸ clearApiKeys(): void

Defined in src/Configuration.ts:427

Returns: void

getAuthMethod#

▸ getAuthMethod(name: string): AuthMethod | undefined

Defined in src/Configuration.ts:386

Returns the AuthMethod with the given name if available with the configured cluster.

Parameters:#

Name

Type

Description

name

string

The name of the auth method to retrieve.

Returns: AuthMethod | undefined

getBaseServicePath#

▸ getBaseServicePath(type: any): string

Defined in src/Configuration.ts:398

Parameters:#

Name

Type

type

any

Returns: string

getUserAgent#

▸ getUserAgent(): string

Defined in src/Configuration.ts:431

Returns: string

setApiKey#

▸ setApiKey(prefix: string, token: string): void

Defined in src/Configuration.ts:415

Parameters:#

Name

Type

prefix

string

token

string

Returns: void

setBaseServicePath#

▸ setBaseServicePath(type: any, path: string): void

Defined in src/Configuration.ts:407

Parameters:#

Name

Type

type

any

path

string

Returns: void