Class SecureLoggerCordovaInterface

constructor

• new SecureLoggerCordovaInterface(): SecureLoggerCordovaInterface

• Returns SecureLoggerCordovaInterface

eventFlushErrorCallback

recycleEventsOnFlushFailure

cachingEnabled

• get cachingEnabled(): boolean

• Current state of caching / event flush interval. Use setEventCacheFlushInterval() and disableEventCaching() to enable and disable (respectively) caching and flush interval usage.

  Returns boolean

flushIntervalDelayMs

• get flushIntervalDelayMs(): number

• Delay that will be used when creating the event loop interval for flushing queued events.

  default = 250

  Returns number
• set flushIntervalDelayMs(value): void

• Parameters

  • value: number

  Returns void

maxCachedEvents

• get maxCachedEvents(): number

• Maximum events allowed to be cached before automatic pruning takes effect. See log() for more info.

  default = 1000

  Returns number
• set maxCachedEvents(value): void

• Parameters

  • value: number

  Returns void

capture

• capture(events): Promise<void>

• Uses native-level formatting, and automatically inserts newlines between events when writing formatted content to the log cache.

  Parameters

  • events: SecureLogEvent[]

  Returns Promise<void>

captureText

• captureText(text): Promise<void>

• Writes the given text directly to the log cache without any preprocessing.

  Parameters

  • text: string

  Returns Promise<void>

clearCache

• clearCache(): Promise<void>

• Deletes all logging cache files. Cannot be undone, use with caution.

  Returns Promise<void>

clearEventCacheFlushInterval

• clearEventCacheFlushInterval(): void

• Disables the flush interval if one is set. NOTE: this will leave the current event cache buffer in-tact. To also clear the buffer, call disableEventCaching() instead.

  Returns void

closeActiveStream

• closeActiveStream(): Promise<void>

• Manually close the current active file stream which logs are being written to.

  Call this if your app is about to close and you want to prevent potential log data loss

  (e.g. if the app is about to be killed non-gracefully and native on-destroy callbacks will not get called)

  Returns Promise<void>

configure

• configure(options): Promise<ConfigureResult>

• Customize how this plugin should operate.

  Parameters

  • options: ConfigureOptions

  Returns Promise<ConfigureResult>

debug

• debug(tag, message, timestamp?): void

• Queues a new log event with the given data and level of DEBUG

  Parameters

  • tag: string

  • message: string

  • Optional timestamp: number

  Returns void

disableEventCaching

• disableEventCaching(): void

• Completely disables event caching on this interface, and clears any buffered events. NOTE: convenience methods that use log() will do nothing until caching is turned back on.

  Returns void

error

• error(tag, message, timestamp?): void

• Queues a new log event with the given data and level of ERROR

  Parameters

  • tag: string

  • message: string

  • Optional timestamp: number

  Returns void

fatal

• fatal(tag, message, timestamp?): void

• Queues a new log event with the given data and level of FATAL

  Parameters

  • tag: string

  • message: string

  • Optional timestamp: number

  Returns void

flushAndCloseActiveStream

• flushAndCloseActiveStream(): Promise<void>

• Convenience for flushing any queued events before actually closing the current stream.

  Returns Promise<void>

flushEventCache

• flushEventCache(): Promise<void>

• Manually flush the current set of cached events. Useful for more pragmatic teardown sequencing.

  Returns Promise<void>

getCacheBlob

• getCacheBlob(): Promise<ArrayBuffer>

• Retrieves a single blob of log data which contains all current log files stitched back together chronologically.

  Returns Promise<ArrayBuffer>

getDebugState

• getDebugState(): Promise<DebugState>

• Get info about the debugging state of the app (i.e. whether or not we're attached to a developer console).

  Returns Promise<DebugState>

info

• info(tag, message, timestamp?): void

• Queues a new log event with the given data and level of INFO

  Parameters

  • tag: string

  • message: string

  • Optional timestamp: number

  Returns void

log

• log(level, tag, message, timestamp?): void

• Generates a log event that will be cached for the next event flush cycle, where all cached events will be handed to the plugin. If this would cause the cache to become larger than maxCachedEvents, the oldest item from the cache is removed after this new event is added.

  Parameters

  • level: SecureLogLevel

  • tag: string

  • message: string

  • timestamp: number = ...

  Returns void

queueEvent

• queueEvent(ev): void

• Adds the given event to the event cache, which will be flushed on a fixed interval.

  Parameters

  • ev: SecureLogEvent

  Returns void

setDebugOutputEnabled

• setDebugOutputEnabled(enabled): Promise<void>

• Change the output state of Timber/Lumberjack native logs. When enabled, native logs will show in logcat/xcode.

  Parameters

  • enabled: boolean

  Returns Promise<void>

setEventCacheFlushInterval

• setEventCacheFlushInterval(intervalMs?): void

• Sets the interval at which cached events will be flushed and sent to the native logging system. If no interval value provided, the current value of flushIntervalDelayMs will be used.

  Parameters

  • Optional intervalMs: number

  Returns void

trace

• trace(tag, message, timestamp?): void

• Alias of verbose()

  Parameters

  • tag: string

  • message: string

  • Optional timestamp: number

  Returns void

verbose

• verbose(tag, message, timestamp?): void

• Queues a new log event with the given data and level of VERBOSE

  Parameters

  • tag: string

  • message: string

  • Optional timestamp: number

  Returns void

warn

• warn(tag, message, timestamp?): void

• Queues a new log event with the given data and level of WARN

  Parameters

  • tag: string

  • message: string

  • Optional timestamp: number

  Returns void