c8osettings.md

c8osdkjscore › C8oSettings

Class: C8oSettings

Contains optional parameters of a C8o class instantiation.
Note that setters return the setting instance thereby C8oSettings can be instantiate like that:
new C8oSettings().setTimeout(5000).setTrustAllCertificates(true).setUseEncryption(true);

Hierarchy

• C8oBase

  ↳ C8oSettings

Index

Constructors

• constructor

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

• addClientCertificate
• addCookie
• addHeader
• clone
• copy
• setAuthenticationCookieValue
• setDefaultDatabaseName
• setDisableResetBase
• setEnablePrefixBase
• setEndPoint
• setErrorConvertigoIntoFail
• setFullSyncLocalSuffix
• setFullSyncPassword
• setFullSyncServerUrl
• setFullSyncUsername
• setKeepSessionAlive
• setLogC8o
• setLogLevelLocal
• setLogOnFail
• setLogRemote
• setNormalizeParameters
• setTimeout
• setUseEncryption

Constructors

constructor

+ new C8oSettings(c8oSettings: C8oSettings): C8oSettings

Defined in c8osdk-js-core/src/c8o/c8oSettings.ts:11

Parameters:

Name	Type	Default
c8oSettings	C8oSettings	null

Returns: C8oSettings

Properties

Protected _authenticationCookieValue

• _authenticationCookieValue: string = null

Inherited from C8oBase._authenticationCookieValue

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

---

Protected _clientCertificateBinaries

• _clientCertificateBinaries: Object

Inherited from C8oBase._clientCertificateBinaries

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

---

Protected _clientCertificateFiles

• _clientCertificateFiles: Object

Inherited from C8oBase._clientCertificateFiles

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

---

Protected _cookies

• _cookies: Object

Inherited from C8oBase._cookies

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

---

Protected _defaultDatabaseName

• _defaultDatabaseName: string = null

Inherited from C8oBase._defaultDatabaseName

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

---

Protected _disableSSL

• _disableSSL: boolean = false

Inherited from C8oBase._disableSSL

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

---

Protected _endpointSettings

• _endpointSettings: string

Inherited from C8oBase._endpointSettings

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

---

Protected _errorConvertigoIntoFail

• _errorConvertigoIntoFail: boolean = false

Inherited from C8oBase._errorConvertigoIntoFail

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

---

Protected _fullSyncLocalSuffix

• _fullSyncLocalSuffix: string = null

Inherited from C8oBase._fullSyncLocalSuffix

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

---

Protected _fullSyncPassword

• _fullSyncPassword: string

Inherited from C8oBase._fullSyncPassword

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

---

Protected _fullSyncServerUrl

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

Inherited from C8oBase._fullSyncServerUrl

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

---

Protected _fullSyncUsername

• _fullSyncUsername: string

Inherited from C8oBase._fullSyncUsername

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

---

Protected _headers

• _headers: Object

Inherited from C8oBase._headers

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

---

Protected _initalLogLevel

• _initalLogLevel: Boolean

Inherited from C8oBase._initalLogLevel

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

---

Protected _initialLogRemote

• _initialLogRemote: boolean = true

Inherited from C8oBase._initialLogRemote

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

---

Protected _keepSessionAlive

• _keepSessionAlive: boolean = true

Inherited from C8oBase._keepSessionAlive

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

---

Protected _keyStorePassword

• _keyStorePassword: string

Inherited from C8oBase._keyStorePassword

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

---

Protected _logC8o

• _logC8o: boolean = false

Inherited from C8oBase._logC8o

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

---

Protected _logLevelLocal

• _logLevelLocal: C8oLogLevel = C8oLogLevel.NONE

Inherited from C8oBase._logLevelLocal

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

---

Protected _logOnFail

• _logOnFail: function

Inherited from C8oBase._logOnFail

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

Inherited from C8oBase._logRemote

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

---

Protected _normalizeParameters

• _normalizeParameters: boolean

Inherited from C8oBase._normalizeParameters

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

---

Protected _prefixBase

• _prefixBase: boolean = false

Inherited from C8oBase._prefixBase

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

---

Protected _resetBase

• _resetBase: boolean = true

Inherited from C8oBase._resetBase

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

---

Protected _timeout

• _timeout: number = -1

Inherited from C8oBase._timeout

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

---

Protected _trustStorePassword

• _trustStorePassword: string

Inherited from C8oBase._trustStorePassword

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

---

Protected _useEncryption

• _useEncryption: boolean = false

Inherited from C8oBase._useEncryption

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

Accessors

authenticationCookieValue

• get authenticationCookieValue(): string

Inherited from C8oBase.authenticationCookieValue

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

Returns: string

---

cookies

• get cookies(): Object

Inherited from C8oBase.cookies

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

Inherited from C8oBase.defaultDatabaseName

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

Returns: string

---

endpoint

• get endpoint(): string

Inherited from C8oBase.endpoint

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

Inherited from C8oBase.errorConvertigoIntoFail

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

Inherited from C8oBase.fullSyncLocalSuffix

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

Returns: string

---

fullSyncPassword

• get fullSyncPassword(): string

Inherited from C8oBase.fullSyncPassword

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

Returns: string

---

fullSyncServerUrl

• get fullSyncServerUrl(): string

Inherited from C8oBase.fullSyncServerUrl

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

Returns: string

---

fullSyncUsername

• get fullSyncUsername(): string

Inherited from C8oBase.fullSyncUsername

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

Returns: string

---

headers

• get headers(): Object

Inherited from C8oBase.headers

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

Returns: Object

---

keepSessionAlive

• get keepSessionAlive(): boolean

Inherited from C8oBase.keepSessionAlive

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

Inherited from C8oBase.logC8o

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

Returns: boolean

---

logLevelLocal

• get logLevelLocal(): C8oLogLevel

Inherited from C8oBase.logLevelLocal

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

Inherited from C8oBase.logOnFail

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

Inherited from C8oBase.logRemote

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

Inherited from C8oBase.normalizeParameters

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

Inherited from C8oBase.prefixBase

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

Inherited from C8oBase.resetBase

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

Inherited from C8oBase.timeout

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

addClientCertificate

▸ addClientCertificate(anyCertificate: string, password: string): C8oSettings

Defined in c8osdk-js-core/src/c8o/c8oSettings.ts:125

addClientCertificate

Parameters:

Name	Type
anyCertificate	string
password	string

Returns: C8oSettings

▸ addClientCertificate(anyCertificate: number, password: string): C8oSettings

Defined in c8osdk-js-core/src/c8o/c8oSettings.ts:133

addClientCertificate

Parameters:

Name	Type
anyCertificate	number
password	string

Returns: C8oSettings

---

addCookie

▸ addCookie(name: string, value: string): C8oSettings

Defined in c8osdk-js-core/src/c8o/c8oSettings.ts:162

Add a new cookie to the initial cookies send to the Convertigo server.

Parameters:

Name	Type	Description
name	string	The name of the new cookie.
value	string	The value of the new cookie.

Returns: C8oSettings

The current C8oSettings, for chaining.

---

addHeader

▸ addHeader(name: string, value: string): this

Defined in c8osdk-js-core/src/c8o/c8oSettings.ts:114

Add a header

Parameters:

Name	Type	Description
name	string	The name of header.
value	string	The value of header.

Returns: this

The current C8oSettings, for chaining.

---

clone

▸ clone(): C8oSettings

Defined in c8osdk-js-core/src/c8o/c8oSettings.ts:26

Clone C8osettings object

Returns: C8oSettings

---

copy

▸ copy(c8oBase: C8oBase): void

Inherited from C8oBase.copy

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

Parameters:

Name	Type
c8oBase	C8oBase

Returns: void

---

setAuthenticationCookieValue

▸ setAuthenticationCookieValue(authenticationCookieValue: string): C8oSettings

Defined in c8osdk-js-core/src/c8o/c8oSettings.ts:229

setAuthenticationCookieValue

Parameters:

Name	Type
authenticationCookieValue	string

Returns: C8oSettings

---

setDefaultDatabaseName

▸ setDefaultDatabaseName(defaultDatabaseName: string): C8oSettings

Defined in c8osdk-js-core/src/c8o/c8oSettings.ts:219

Specify the default FullSync database name. Must match a Convertigo Server FullSync connector name

Parameters:

Name	Type
defaultDatabaseName	string

Returns: C8oSettings

The current C8oSettings, for chaining.

---

setDisableResetBase

▸ setDisableResetBase(resetBase: boolean): C8oSettings

Defined in c8osdk-js-core/src/c8o/c8oSettings.ts:68

Sets the if base has to be reseted on dectecting diffrent versions

Parameters:

Name	Type	Description
resetBase	boolean	if you to able reset base

Returns: C8oSettings

The current C8oSettings, for chaining.

---

setEnablePrefixBase

▸ setEnablePrefixBase(prefixBase: boolean): C8oSettings

Defined in c8osdk-js-core/src/c8o/c8oSettings.ts:78

Sets the if base has to be prefixed by user name

Parameters:

Name	Type	Description
prefixBase	boolean	if you to able prefix base

Returns: C8oSettings

The current C8oSettings, for chaining.

---

setEndPoint

▸ setEndPoint(endpoint: string): C8oSettings

Defined in c8osdk-js-core/src/c8o/c8oSettings.ts:90

Sets the endpoint (override env.json).

Parameters:

Name	Type	Description
endpoint	string	The endpoint.

Returns: C8oSettings

The current C8oSettings, for chaining.

---

setErrorConvertigoIntoFail

▸ setErrorConvertigoIntoFail(errorConvertigoIntoFail: boolean): C8oSettings

Defined in c8osdk-js-core/src/c8o/c8oSettings.ts:55

Sets if the error convertigo is throw in fail or not

Parameters:

Name	Type	Description
errorConvertigoIntoFail	boolean	boolean

Returns: C8oSettings

The current C8oSettings, for chaining.

---

setFullSyncLocalSuffix

▸ setFullSyncLocalSuffix(fullSyncLocalSuffix: string): C8oSettings

Defined in c8osdk-js-core/src/c8o/c8oSettings.ts:269

setFullSyncLocalSuffix

Parameters:

Name	Type
fullSyncLocalSuffix	string

Returns: C8oSettings

---

setFullSyncPassword

▸ setFullSyncPassword(fullSyncPassword: string): C8oSettings

Defined in c8osdk-js-core/src/c8o/c8oSettings.ts:259

setFullSyncPassword

Parameters:

Name	Type
fullSyncPassword	string

Returns: C8oSettings

---

setFullSyncServerUrl

▸ setFullSyncServerUrl(fullSyncServerUrl: string): C8oSettings

Defined in c8osdk-js-core/src/c8o/c8oSettings.ts:239

setFullSyncServerUrl

Parameters:

Name	Type
fullSyncServerUrl	string

Returns: C8oSettings

---

setFullSyncUsername

▸ setFullSyncUsername(fullSyncUsername: string): C8oSettings

Defined in c8osdk-js-core/src/c8o/c8oSettings.ts:249

setFullSyncUsername

Parameters:

Name	Type
fullSyncUsername	string

Returns: C8oSettings

---

setKeepSessionAlive

▸ setKeepSessionAlive(keepAlive: boolean): C8oSettings

Defined in c8osdk-js-core/src/c8o/c8oSettings.ts:45

Sets the if session has to be maintain alive

Parameters:

Name	Type	Description
keepAlive	boolean	if session has to be keep Alive

Returns: C8oSettings

The current C8oSettings, for chaining.

---

setLogC8o

▸ setLogC8o(logC8o: boolean): C8oSettings

Defined in c8osdk-js-core/src/c8o/c8oSettings.ts:197

setLogC8o

Parameters:

Name	Type
logC8o	boolean

Returns: C8oSettings

---

setLogLevelLocal

▸ setLogLevelLocal(logLevelLocal: C8oLogLevel): C8oSettings

Defined in c8osdk-js-core/src/c8o/c8oSettings.ts:187

Sets a value indicating the log level you want in the device console 0: ALL, 1: NONE, 2: TRACE, 3: DEBUG, 4: INFO, 5: WARN, 6: ERROR, 7: FATAL or use the android.util.Log constants Default is 0.

Parameters:

Name	Type
logLevelLocal	C8oLogLevel

Returns: C8oSettings

The current C8oSettings, for chaining.

---

setLogOnFail

▸ setLogOnFail(logOnFail: function): C8oSettings

Defined in c8osdk-js-core/src/c8o/c8oSettings.ts:207

setLogOnFail

Parameters:

▪ logOnFail: function

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

Parameters:

Name	Type
exception	Error
parameters	Object

Returns: C8oSettings

---

setLogRemote

▸ setLogRemote(logRemote: boolean): C8oSettings

Defined in c8osdk-js-core/src/c8o/c8oSettings.ts:175

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

Parameters:

Name	Type
logRemote	boolean

Returns: C8oSettings

The current C8oSettings, for chaining.

---

setNormalizeParameters

▸ setNormalizeParameters(normalize: boolean): C8oSettings

Defined in c8osdk-js-core/src/c8o/c8oSettings.ts:35

Sets the normalizeParameters. define if we normalize parameters of every calls using JSON.parse(JSON.stringify(parameters))

Parameters:

Name	Type	Description
normalize	boolean	boolean.

Returns: C8oSettings

The current C8oSettings, for chaining.

---

setTimeout

▸ setTimeout(timeout: number): C8oSettings

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

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

Parameters:

Name	Type	Description
timeout	number	The timeout.

Returns: C8oSettings

The current C8oSettings, for chaining.

---

setUseEncryption

▸ setUseEncryption(useEncryption: boolean): C8oSettings

Defined in c8osdk-js-core/src/c8o/c8oSettings.ts:280

Set if c8o calls variables are encrypted or not

Parameters:

Name	Type
useEncryption	boolean

Returns: C8oSettings

The current C8oSettings, for chaining.