registerEvent

fun registerEvent(eventId: String, description: String): EventId

Registers an event with the specified event ID and description.

Return

The registered event as an instance of EventId.

Parameters

eventId

The unique identifier of the event to be registered.

description

A brief description of the event. This value cannot be empty and null. The description is registered at event initialization using the RegisteredLogDescriptionsProcessor. There is no description in the memory if RegisteredLogDescriptionsProcessor.descriptionRegistrationEnabled is false.

Throws

If the description is an empty string.


fun <T1> registerEvent(eventId: String, eventField1: EventField<T1>, description: String): EventId1<T1>

Registers an event with the specified event ID, a single event field, and a description.

Return

The registered event as an instance of EventId1.

Parameters

eventId

The unique identifier of the event to be registered.

eventField1

The field associated with the event. This field provides additional data for the event.

description

A brief description of the event. This value must not be null or empty. The description is registered at event initialization using the RegisteredLogDescriptionsProcessor. There is no description in the memory if RegisteredLogDescriptionsProcessor.descriptionRegistrationEnabled is false.

Throws

If the description is an empty string.


fun <T1, T2> registerEvent(eventId: String, eventField1: EventField<T1>, eventField2: EventField<T2>, description: String): EventId2<T1, T2>

Registers an event with the specified event ID, two event fields, and a description.

Return

The registered event as an instance of EventId2, containing the two specified fields.

Parameters

eventId

The unique identifier of the event to be registered.

eventField1

The first field associated with the event, providing additional data for the event.

eventField2

The second field associated with the event, providing additional data for the event.

description

A brief description of the event. This value must not be null or empty. The description is registered at event initialization using the RegisteredLogDescriptionsProcessor. There is no description in the memory if RegisteredLogDescriptionsProcessor.descriptionRegistrationEnabled is false.

Throws

If the description is an empty string.


fun <T1, T2, T3> registerEvent(eventId: String, eventField1: EventField<T1>, eventField2: EventField<T2>, eventField3: EventField<T3>, description: String): EventId3<T1, T2, T3>

Registers an event with the specified event ID, three event fields, and a description.

Return

The registered event as an instance of EventId3.

Parameters

eventId

The unique identifier of the event to be registered.

eventField1

The first field associated with the event. This field provides additional data for the event.

eventField2

The second field associated with the event. This field provides additional data for the event.

eventField3

The third field associated with the event. This field provides additional data for the event.

description

A brief description of the event. This value must not be null or empty. The description is registered at event initialization using the RegisteredLogDescriptionsProcessor. There is no description in the memory if RegisteredLogDescriptionsProcessor.descriptionRegistrationEnabled is false.

Throws

If the description is an empty string.


fun <D : FieldListDescription> registerEvent(eventId: String, creator: () -> D, description: String): VarargEventId<D>

Registers an event with the specified event ID, a field list, and a description.

Return

The registered event as an instance of VarargEventId containing the field list description.

Parameters

eventId

The unique identifier of the event to be registered.

creator

A lambda function used to create the field list for the event.

description

A brief description of the event. This value must not be null or empty. The description is registered at event initialization using the RegisteredLogDescriptionsProcessor. There is no description in the memory if RegisteredLogDescriptionsProcessor.descriptionRegistrationEnabled is false.

Throws

If the description is an empty string.