/ fm / liveswitch / LogEventInfo

Class: LogEventInfo

fm.liveswitch.LogEventInfo

Log event information.

Hierarchy

  • Info

    ↳ LogEventInfo

Table of contents

Constructors

Methods

Constructors

constructor

+ new LogEventInfo(): LogEventInfo

Returns: LogEventInfo

Inherited from: Info

Methods

deserializeProperties

▸ ProtecteddeserializeProperties(key: string, valueJson: string): void

Deserializes the properties.

Parameters:

Name Type Description
key string The key.
valueJson string The value in JSON format.

Returns: void

Overrides: Info

fmliveswitchLogEventInfoInit

▸ PrivatefmliveswitchLogEventInfoInit(): void

Returns: void

getException

▸ getException(): string

Gets the log event exception message.

Returns: string

getId

▸ getId(): string

Gets the identifier.

Returns: string

Inherited from: Info

getLevel

▸ getLevel(): string

Gets the log event level.

Returns: string

getMessage

▸ getMessage(): string

Gets the log event message.

Returns: string

getScope

▸ getScope(): string

Gets the log event scope.

Returns: string

getTag

▸ getTag(): string

Gets the log event tag.

Returns: string

getThreadId

▸ getThreadId(): number

Gets the log event thread ID.

Returns: number

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Info

serializeProperties

▸ ProtectedserializeProperties(jsonObject: Hash<string, string>): void

Serializes the properties.

Parameters:

Name Type Description
jsonObject Hash<string, string> The JSON object.

Returns: void

Overrides: Info

setException

▸ setException(value: string): void

Sets the log event exception message.

Parameters:

Name Type
value string

Returns: void

setId

▸ setId(value: string): void

Sets the identifier.

Parameters:

Name Type
value string

Returns: void

Inherited from: Info

setMessage

▸ setMessage(value: string): void

Sets the log event message.

Parameters:

Name Type
value string

Returns: void

setScope

▸ setScope(value: string): void

Sets the log event scope.

Parameters:

Name Type
value string

Returns: void

setTag

▸ setTag(value: string): void

Sets the log event tag.

Parameters:

Name Type
value string

Returns: void

setThreadId

▸ setThreadId(value: number): void

Sets the log event thread ID.

Parameters:

Name Type
value number

Returns: void

toJson

▸ toJson(): string

Serializes this instance to Json.

Returns: string

fromJson

▸ StaticfromJson(logEventInfoJson: string): LogEventInfo

Deserializes Json to a LogEventInfo.

Parameters:

Name Type Description
logEventInfoJson string The serialized Json.

Returns: LogEventInfo

The deserialized LogEventInfo.

processArray

▸ StaticprocessArray<T>(newValues: T[], oldValues: T[]): T[]

Processes an array for an info.

Type parameters:

Name Type
T IEquivalent<T, T>

Parameters:

Name Type Description
newValues T[] The new values.
oldValues T[] The old values.

Returns: T[]

The new values, if the new values are not equivalent to the old values; otherwise null.

Inherited from: Info

processBoolean

▸ StaticprocessBoolean(newValue: boolean, oldValue: boolean): boolean

Processes a boolean for an info.

Parameters:

Name Type Description
newValue boolean The new value.
oldValue boolean The old value.

Returns: boolean

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Info

processBooleanArray

▸ StaticprocessBooleanArray(newValues: boolean[], oldValues: boolean[]): boolean[]

Processes a boolean array for an info.

Parameters:

Name Type Description
newValues boolean[] The new values.
oldValues boolean[] The old values.

Returns: boolean[]

The new values, if the new values do not equal the old values; otherwise null.

Inherited from: Info

processDouble

▸ StaticprocessDouble(newValue: number, oldValue: number): number

Processes a double for an info.

Parameters:

Name Type Description
newValue number The new value.
oldValue number The old value.

Returns: number

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Info

processFloat

▸ StaticprocessFloat(newValue: number, oldValue: number): number

Processes a float for an info.

Parameters:

Name Type Description
newValue number The new value.
oldValue number The old value.

Returns: number

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Info

processFloatArray

▸ StaticprocessFloatArray(newValues: number[], oldValues: number[]): number[]

Processes a float array for an info.

Parameters:

Name Type Description
newValues number[] The new values.
oldValues number[] The old values.

Returns: number[]

The new values, if the new values do not equal the old values; otherwise null.

Inherited from: Info

processInteger

▸ StaticprocessInteger(newValue: number, oldValue: number): number

Processes an integer for an info.

Parameters:

Name Type Description
newValue number The new value.
oldValue number The old value.

Returns: number

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Info

processIntegerArray

▸ StaticprocessIntegerArray(newValues: number[], oldValues: number[]): number[]

Processes a integer array for an info.

Parameters:

Name Type Description
newValues number[] The new values.
oldValues number[] The old values.

Returns: number[]

The new values, if the new values do not equal the old values; otherwise null.

Inherited from: Info

processLong

▸ StaticprocessLong(newValue: number, oldValue: number): number

Processes a long for an info.

Parameters:

Name Type Description
newValue number The new value.
oldValue number The old value.

Returns: number

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Info

processLongArray

▸ StaticprocessLongArray(newValues: number[], oldValues: number[]): number[]

Processes a long array for an info.

Parameters:

Name Type Description
newValues number[] The new values.
oldValues number[] The old values.

Returns: number[]

The new values, if the new values do not equal the old values; otherwise null.

Inherited from: Info

processObject

▸ StaticprocessObject<T>(newValue: T, oldValue: T): T

Processes an object for an info.

Type parameters:

Name Type
T Object & IEquivalent<T, T>

Parameters:

Name Type Description
newValue T The new value.
oldValue T The old value.

Returns: T

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Info

processShort

▸ StaticprocessShort(newValue: number, oldValue: number): number

Processes a short for an info.

Parameters:

Name Type Description
newValue number The new value.
oldValue number The old value.

Returns: number

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Info

processShortArray

▸ StaticprocessShortArray(newValues: number[], oldValues: number[]): number[]

Processes a short array for an info.

Parameters:

Name Type Description
newValues number[] The new values.
oldValues number[] The old values.

Returns: number[]

The new values, if the new values do not equal the old values; otherwise null.

Inherited from: Info

processString

▸ StaticprocessString(newValue: string, oldValue: string): string

Processes a string for an info.

Parameters:

Name Type Description
newValue string The new value.
oldValue string The old value.

Returns: string

The new value, if the new value does not equal the old value; otherwise null.

Inherited from: Info

toJson

▸ StatictoJson(logEventInfo: LogEventInfo): string

Serializes an instance to Json.

Parameters:

Name Type Description
logEventInfo LogEventInfo The instance to serialize.

Returns: string

Serialized Json.