c8obase.md

c8osdkjscore › C8oBase

Class: C8oBase

Hierarchy

• C8oBase

  ↳ C8oSettings

  ↳ C8oCore

Index

Properties

• _authenticationCookieValue
• _clientCertificateBinaries
• _clientCertificateFiles
• _cookies
• _defaultDatabaseName
• _disableSSL
• _endpointSettings
• _errorConvertigoIntoFail
• _fullSyncLocalSuffix
• _fullSyncPassword
• _fullSyncServerUrl
• _fullSyncUsername
• _headers
• _initalLogLevel
• _initialLogRemote
• _keepSessionAlive
• _keyStorePassword
• _logC8o
• _logLevelLocal
• _logOnFail
• _logRemote
• _normalizeParameters
• _prefixBase
• _resetBase
• _timeout
• _trustStorePassword
• _useEncryption

Accessors

• authenticationCookieValue
• cookies
• defaultDatabaseName
• endpoint
• errorConvertigoIntoFail
• fullSyncLocalSuffix
• fullSyncPassword
• fullSyncServerUrl
• fullSyncUsername
• headers
• keepSessionAlive
• logC8o
• logLevelLocal
• logOnFail
• logRemote
• normalizeParameters
• prefixBase
• resetBase
• timeout

Methods

• copy

Properties

Protected _authenticationCookieValue

• _authenticationCookieValue: string = null

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:21

---

Protected _clientCertificateBinaries

• _clientCertificateBinaries: Object

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:10

---

Protected _clientCertificateFiles

• _clientCertificateFiles: Object

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:9

---

Protected _cookies

• _cookies: Object

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:8

---

Protected _defaultDatabaseName

• _defaultDatabaseName: string = null

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:20

---

Protected _disableSSL

• _disableSSL: boolean = false

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:29

---

Protected _endpointSettings

• _endpointSettings: string

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:5

---

Protected _errorConvertigoIntoFail

• _errorConvertigoIntoFail: boolean = false

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:40

---

Protected _fullSyncLocalSuffix

• _fullSyncLocalSuffix: string = null

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:22

---

Protected _fullSyncPassword

• _fullSyncPassword: string

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:25

---

Protected _fullSyncServerUrl

• _fullSyncServerUrl: string = "http://localhost:5984"

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:23

---

Protected _fullSyncUsername

• _fullSyncUsername: string

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:24

---

Protected _headers

• _headers: Object

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:46

---

Protected _initalLogLevel

• _initalLogLevel: Boolean

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:48

---

Protected _initialLogRemote

• _initialLogRemote: boolean = true

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:14

---

Protected _keepSessionAlive

• _keepSessionAlive: boolean = true

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:38

---

Protected _keyStorePassword

• _keyStorePassword: string

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:31

---

Protected _logC8o

• _logC8o: boolean = false

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:16

---

Protected _logLevelLocal

• _logLevelLocal: C8oLogLevel = C8oLogLevel.NONE

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:15

---

Protected _logOnFail

• _logOnFail: function

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:17

Type declaration:

▸ (exception: Error, parameters: Object): void

Parameters:

Name	Type
exception	Error
parameters	Object

---

Protected _logRemote

• _logRemote: boolean = true

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:13

---

Protected _normalizeParameters

• _normalizeParameters: boolean

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:36

---

Protected _prefixBase

• _prefixBase: boolean = false

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:44

---

Protected _resetBase

• _resetBase: boolean = true

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:42

---

Protected _timeout

• _timeout: number = -1

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:6

---

Protected _trustStorePassword

• _trustStorePassword: string

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:33

---

Protected _useEncryption

• _useEncryption: boolean = false

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:28

Accessors

authenticationCookieValue

• get authenticationCookieValue(): string

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:149

Returns: string

---

cookies

• get cookies(): Object

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:119

Gets initial cookies to send to the Convertigo server.
Default is null.

Returns: Object

List of cookies.

---

defaultDatabaseName

• get defaultDatabaseName(): string

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:145

Returns: string

---

endpoint

• get endpoint(): string

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:180

Gets the endpoint define in C8oSettings

Returns: string

The current endpoint, if defined by c8oSettings.

---

errorConvertigoIntoFail

• get errorConvertigoIntoFail(): boolean

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:73

Gets if error convertigo are thrown into fail.
Default is false.

Returns: boolean

The errorConvertigoIntoFail status.

---

fullSyncLocalSuffix

• get fullSyncLocalSuffix(): string

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:153

Returns: string

---

fullSyncPassword

• get fullSyncPassword(): string

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:168

Returns: string

---

fullSyncServerUrl

• get fullSyncServerUrl(): string

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:158

Returns: string

---

fullSyncUsername

• get fullSyncUsername(): string

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:163

Returns: string

---

headers

• get headers(): Object

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:184

Returns: Object

---

keepSessionAlive

• get keepSessionAlive(): boolean

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:64

Gets if session has to be keep alive.
Default is true.

Returns: boolean

The KeepSessionAlive status.

---

logC8o

• get logC8o(): boolean

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:141

Returns: boolean

---

logLevelLocal

• get logLevelLocal(): C8oLogLevel

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:137

Gets a value indicating logs level local

Returns: C8oLogLevel

C8oLogLevel object

---

logOnFail

• get logOnFail(): function

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:172

Returns: function

▸ (exception: Error, parameters: Object): void

Parameters:

Name	Type
exception	Error
parameters	Object

---

logRemote

• get logRemote(): boolean

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:128

Gets a value indicating if logs are sent to the Convertigo server.
Default is true.

Returns: boolean

true if logs are sent to the Convertigo server; otherwise, false.

---

normalizeParameters

• get normalizeParameters(): boolean

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:56

Gets if normalize parameters.
Default is false.

Returns: boolean

The timeout.

---

prefixBase

• get prefixBase(): boolean

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:92

Gets if we have to prefix databases with user name.
Default is false.

Returns: boolean

The prefix base status.

---

resetBase

• get resetBase(): boolean

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:83

Gets if reset database is disabled.
Default is true.

Returns: boolean

The disable reset base status.

---

timeout

• get timeout(): number

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:101

Gets the connection timeout to Convertigo in milliseconds. A value of zero means the timeout is not used.
Default is 0.

Returns: number

The timeout.

Methods

copy

▸ copy(c8oBase: C8oBase): void

Defined in c8osdk-js-core/src/c8o/c8oBase.ts:188

Parameters:

Name	Type
c8oBase	C8oBase

Returns: void