Class: LoggerManager¶
Hierarchy¶
- LoggerManager
Summary¶
Methods¶
Class Methods¶
- getLevel
- getLevelFromUserDefaults
- isLogSeverityHigher
- isTurnedOn
- log
- logTraceToFile
- off
- on
- setLevel
- toggle
- uploadLogFile
- clearLog
- getInstance
- init
Inherited Methods¶
Currently none inherited from the parent class(es).
Methods¶
getLevel¶
▸ getLevel(): string
Returns: string
getLevelFromUserDefaults¶
▸ getLevelFromUserDefaults(): string
Returns: string
isLogSeverityHigher¶
▸ isLogSeverityHigher(severity: string): boolean
Parameters:
| Name | Type | Description |
|---|---|---|
severity |
string | The severity level. Its values can be: Error, Warn, Info, Debug, Trace, Off. |
Returns: boolean
isTurnedOn¶
▸ isTurnedOn(): boolean
Returns: boolean
log¶
▸ log(message: string, severity: string, logToConsole: boolean): Promise‹any›
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
message |
string | - | The message to be logged. |
severity |
string | undefined | Optional. The severity of the log level for logging this message. If the severity parameter is not specified or invalid, the root log level will be used. |
logToConsole |
boolean | true | - |
Returns: Promise‹any›
logTraceToFile¶
▸ logTraceToFile(message: string, category: string, type: number): Promise‹any›
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
message |
string | - | The message to be written. |
category |
string | - | The category of the message. |
type |
number | 0 | Optional, the type of the message - info, warning, error. |
Returns: Promise‹any›
off¶
▸ off(): Promise‹any›
Returns: Promise‹any›
on¶
▸ on(): Promise‹any›
Returns: Promise‹any›
setLevel¶
▸ setLevel(newLevel: string): Promise‹any›
Parameters:
| Name | Type | Description |
|---|---|---|
newLevel |
string | The log level. Its values can be: Error, Warn, Info, Debug, Trace, Off. |
Returns: Promise‹any›
toggle¶
▸ toggle(): Promise‹any›
Returns: Promise‹any›
uploadLogFile¶
▸ uploadLogFile(backendURL: string, applicationID: string): Promise‹any›
Parameters:
| Name | Type | Description |
|---|---|---|
backendURL |
string | The backend URL. |
applicationID |
string | The application ID. |
Returns: Promise‹any›
Static clearLog¶
▸ clearLog(): void
Returns: void
Static getInstance¶
▸ getInstance(): any
Returns: any
the instance of the LoggerManager .
Static init¶
▸ init(logFileName: string, maxFileSizeInMegaBytes: number): void
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
logFileName |
string | "ClientLog.txt" | Optional, file name of the local log file on the client device. The default value is "ClientLog.txt". |
maxFileSizeInMegaBytes |
number | 1 | Optional, max file size before rollover of the local log file on the client device. The default value is 1MB. The default root log level is 'Error' according to SAP SDK. |
Returns: void