c8outilscore.md

c8osdkjscore › C8oUtilsCore

Class: C8oUtilsCore

Hierarchy

• C8oUtilsCore

  ↳ C8oUtils

Index

Constructors

• constructor

Properties

• data
• USE_PARAMETER_IDENTIFIER

Methods

• MD5
• MD5ArrayBuffer
• checkHeaderArgument
• getNewGUIDString
• getObjectClassName
• getParameter
• getParameterObjectValue
• getParameterStringValue
• identifyC8oCallRequest
• isValidUrl
• peekParameterObjectValue
• peekParameterStringValue

Constructors

constructor

+ new C8oUtilsCore(): C8oUtilsCore

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

Returns: C8oUtilsCore

Properties

data

• data: JSON

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

---

Static Private USE_PARAMETER_IDENTIFIER

▪ USE_PARAMETER_IDENTIFIER: string = "use"

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

FullSync parameters prefix.

Methods

Static MD5

▸ MD5(str: string): string

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

returns 128 bits hash using MD5 algo

Parameters:

Name	Type	Description
str	string	any string

Returns: string

---

Static MD5ArrayBuffer

▸ MD5ArrayBuffer(str: any): Buffer

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

Parameters:

Name	Type	Description
str	any	any string

Returns: Buffer

---

Static checkHeaderArgument

▸ checkHeaderArgument(response: any, argument: any): any

Defined in c8osdk-js-core/src/c8o/c8oUtilsCore.ts:154

Parameters:

Name	Type
response	any
argument	any

Returns: any

---

Static getNewGUIDString

▸ getNewGUIDString(): string

Defined in c8osdk-js-core/src/c8o/c8oUtilsCore.ts:43

Returns: string

---

Static getObjectClassName

▸ getObjectClassName(object: any): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function"

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

Returns the class name of the object as a String, if the object is null then returns the String "null".

Parameters:

Name	Type
object	any

Returns: "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function"

string

---

Static getParameter

▸ getParameter(parameters: Object, name: string, useName: boolean): any

Defined in c8osdk-js-core/src/c8o/c8oUtilsCore.ts:74

TAG Parameter

Parameters:

Name	Type
parameters	Object
name	string
useName	boolean

Returns: any

---

Static getParameterObjectValue

▸ getParameterObjectValue(parameters: Object, name: string, useName: boolean): any

Defined in c8osdk-js-core/src/c8o/c8oUtilsCore.ts:103

Parameters:

Name	Type	Default
parameters	Object	-
name	string	-
useName	boolean	false

Returns: any

---

Static getParameterStringValue

▸ getParameterStringValue(parameters: Object, name: string, useName: boolean): string

Defined in c8osdk-js-core/src/c8o/c8oUtilsCore.ts:95

Searches in the list the parameter with this specific name (or the same name with the prefix 'use') and returns it.
Returns null if the parameter is not found.

Parameters:

Name	Type
parameters	Object
name	string
useName	boolean

Returns: string

string

---

Static identifyC8oCallRequest

▸ identifyC8oCallRequest(parameters: Object, responseType: string): string

Defined in c8osdk-js-core/src/c8o/c8oUtilsCore.ts:150

Serializes a c8o call request thanks to its parameters and response type.

throws C8oException

Parameters:

Name	Type
parameters	Object
responseType	string

Returns: string

string

---

Static isValidUrl

▸ isValidUrl(url: string): boolean

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

Parameters:

Name	Type
url	string

Returns: boolean

---

Static peekParameterObjectValue

▸ peekParameterObjectValue(parameters: Object, name: string, exceptionIfMissing: boolean): string

Defined in c8osdk-js-core/src/c8o/c8oUtilsCore.ts:129

Parameters:

Name	Type
parameters	Object
name	string
exceptionIfMissing	boolean

Returns: string

---

Static peekParameterStringValue

▸ peekParameterStringValue(parameters: Object, name: string, exceptionIfMissing: boolean): string

Defined in c8osdk-js-core/src/c8o/c8oUtilsCore.ts:115

Parameters:

Name	Type
parameters	Object
name	string
exceptionIfMissing	boolean

Returns: string