register Event
Registers an event with the specified event ID and description.
Return
The registered event as an instance of EventId.
Parameters
The unique identifier of the event to be registered.
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.
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
The unique identifier of the event to be registered.
The field associated with the event. This field provides additional data for the event.
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.
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
The unique identifier of the event to be registered.
The first field associated with the event, providing additional data for the event.
The second field associated with the event, providing additional data for the event.
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.
Registers an event with the specified event ID, three event fields, and a description.
Return
The registered event as an instance of EventId3.
Parameters
The unique identifier of the event to be registered.
The first field associated with the event. This field provides additional data for the event.
The second field associated with the event. This field provides additional data for the event.
The third field associated with the event. This field provides additional data for the event.
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.
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
The unique identifier of the event to be registered.
A lambda function used to create the field list for the event.
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.