Interface IAnalyticsDispatcher
Each dispatcher is responsible for outputting IAnalyticsEvents. This may be to the console, or to an endpoint.
Namespace: IdleKit.Analytics
Assembly: cs.temp.dll.dll
Syntax
public interface IAnalyticsDispatcher : IInjectableMethods
Cleanup()
Cleanup any hanging listeners or other references before being destroyed.
Declaration
void Cleanup()Initialize()
Run any required initialization on the dispatcher.
Declaration
void Initialize()LogEvent(IAnalyticsEvent)
Log a single event.
Declaration
void LogEvent(IAnalyticsEvent analyticsEvent)Parameters
| Type | Name | Description |
|---|---|---|
| IAnalyticsEvent | analyticsEvent | The event to pass to the running IAnalyticsDispatcher objects. |
LogEvents(IEnumerable<IAnalyticsEvent>)
Log multiple events. Some endpoints might support sending a single batch of multiple events.
Declaration
void LogEvents(IEnumerable<IAnalyticsEvent> analyticsEvents)Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<IAnalyticsEvent> | analyticsEvents | The events to pass to the running IAnalyticsDispatcher objects. |
SendPendingEvents()
Immediately send any waiting events to their destination if necessary.
Declaration
void SendPendingEvents()UpdatePendingEvents(Action<IEnumerable<IAnalyticsEvent>>)
Run a method on cached pending events. This can be useful if pending events need to have some data changed prior to sending them.
Declaration
void UpdatePendingEvents(Action<IEnumerable<IAnalyticsEvent>> updateMethod)Parameters
| Type | Name | Description |
|---|---|---|
| Action<IEnumerable<IAnalyticsEvent>> | updateMethod | The method to run on every cached event. |