Class InternalLogMessage

This class specifies message objects that are used for internally collecting the properties of an actual log message. Thus, it provides setters and getters of all message properties.

Hierarchy (view full)

Constructors

Properties

_category: null | string | Category

The category classifying the log message. The syntax is 'Category.Subcategory.*'.

_id: null | string

An id that can be set in order to identify a specific log message.

_message: string

The actual message containing '%key%' entries that will be replaced with the values of the respective keys in the parameters object.

_onceId: null | string | boolean

An id that enables the message to be logged only once. If set to true, at least the message id must be set.

_origin: null | string

An optional origin (runtime environment, process id, etc.) where the instance of the code from where the message originates has been executed.

_parameters: null | object

An optional parameters object containing some parameters that are to be inserted into the message string.

_ref: string

The reference to the source code structural entity ("Module:Submodule:Class:Function") where the log message has been created.

_severity: Severity

The severity of the log message.

_time: Date

The time of creation of the log message.

NO_MESSAGE: string = "NO_MESSAGE"
NO_REF: string = "NO_REF"

Accessors

  • get id(): null | string
  • Returns null | string

  • set id(id): void
  • Parameters

    • id: null | string

    Returns void

  • get message(): string
  • Returns string

  • set message(message): void
  • Parameters

    • message: string

    Returns void

  • get onceId(): null | string | boolean
  • Returns null | string | boolean

  • set onceId(onceId): void
  • Parameters

    • onceId: null | string | boolean

    Returns void

  • get origin(): null | string
  • Returns null | string

  • set origin(origin): void
  • Parameters

    • origin: null | string

    Returns void

  • get parameters(): null | object
  • Returns null | object

  • set parameters(parameters): void
  • Parameters

    • parameters: null | object

    Returns void

  • get ref(): string
  • Returns string

  • set ref(ref): void
  • Parameters

    • ref: string

    Returns void