Event List

EventList is a supporting class for the logging system and allows SDK users to collect and inspect a subset of messages emitted by the SDK. The events are stored in an ordered list, each element being a dictionary of string keys and string values.

Upon completion of the API call, the host application can inspect the recorded events to determine what step to take to address the issue. To list all events and their elements, a for-each statement like this will work:

corpus.SetEventCallback(eventCallback, CdmStatusLevel.Warning, userSessionCorrelationId);

var manifest = await corpus.FetchObjectAsync<CdmManifestDefinition>(userSuppliedManifestPath);

corpus.Ctx.Events.ForEach(
    logEntry => logEntry.ToList().ForEach(
        logEntryPair => Console.WriteLine($"{logEntryPair.Key}={logEntryPair.Value}")
    )
);

Note: The logs returned in the callback may include potentially sensitive information about the code infrastructure and as a result, it's recommended that these logs aren't provided directly to the customer.

Note: This class is NOT a replacement for standard logging mechanism employed by the SDK. It serves specifically to offer immediate post-call context specific diagnostic information for the application to automate handling of certain common problems, such as invalid file name being supplied, file already being present on the file-system, etc.

public class EventList extends List<Dictionary<string, string>>

*Note: Typescript version of this class does not extend lists, it instead contains the list of events in its publicly accessible field allItems.

Properties

Name	Type	Description
IsRecording	bool	Specifies if the recording of events is in progress. Read-only.
ApiCorrelationId	Guid	A GUID that is automatically generated and added to the event when the outermost-level API method is called. The methods called internally will have the same ID as the outermost-level method. Read-only.