Show / Hide Table of Contents

    Class AnalyticsEventBase

    Appends common information to event data including an event name, timestamp and IAnalyticsUserData. It is recommended that each event implementation extends this class.

    Inheritance
    Object
    AnalyticsEventBase
    ABTestEvent
    AchievementEvent
    AdHocEvent
    ContentSummaryEvent
    CurrencyEvent
    DialogSequenceEvent
    DownloadPromptEvent
    ErrorEvent
    GachaOpenedEvent
    InstallEvent
    KraangBatchEvent
    PlayerDataEvent
    PurchaseEvent
    PurchaseFailedEvent
    PushNotificationEvent
    QuestProgressionEvent
    SessionBeginEvent
    SessionEndEvent
    Implements
    IAnalyticsEvent
    IInjectable
    Inherited Members
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Object.ToString()
    Object.ReferenceEquals(Object, Object)
    Namespace: IdleKit.Analytics
    Assembly: cs.temp.dll.dll
    Syntax
    public abstract class AnalyticsEventBase : IAnalyticsEvent, IInjectable

    Constructors

    AnalyticsEventBase()

    Declaration
    protected AnalyticsEventBase()

    Fields

    _timestampInMilliseconds

    Declaration
    protected long _timestampInMilliseconds
    Field Value
    Type Description
    Int64

    _uuid

    Declaration
    protected string _uuid
    Field Value
    Type Description
    String

    DATA_MAX_LENGTH

    Declaration
    public const int DATA_MAX_LENGTH = 8192
    Field Value
    Type Description
    Int32

    DEVICE_ID_KEY

    Declaration
    public const string DEVICE_ID_KEY = "deviceId"
    Field Value
    Type Description
    String

    EVENT_NAME_KEY

    Declaration
    public const string EVENT_NAME_KEY = "event"
    Field Value
    Type Description
    String

    TIMESTAMP_KEY

    Declaration
    public const string TIMESTAMP_KEY = "timestamp"
    Field Value
    Type Description
    String

    UUID_KEY

    Declaration
    public const string UUID_KEY = "uuid"
    Field Value
    Type Description
    String

    Properties

    EventName

    The name of the event.

    Declaration
    public abstract string EventName { get; }
    Property Value
    Type Description
    String

    IncludeDeviceId

    Whether or not to include the device ID within the event data. Subclasses can override this method to opt into including the device ID.

    Declaration
    protected virtual bool IncludeDeviceId { get; }
    Property Value
    Type Description
    Boolean

    TimestampInMilliseconds

    The time at which this event was created.

    Declaration
    public virtual long TimestampInMilliseconds { get; }
    Property Value
    Type Description
    Int64

    Methods

    EventContent()

    Event content for the specific event that is being emitted.

    Declaration
    protected abstract Dictionary<string, object> EventContent()
    Returns
    Type Description
    Dictionary<String, Object>

    A dictionary of string attribute names and arbitrary value objects.

    GetEventData()

    Returns a dictionary of base event data.

    Declaration
    public Dictionary<string, object> GetEventData()
    Returns
    Type Description
    Dictionary<String, Object>

    Initialize(Int64, Dictionary<String, Object>)

    This method is called automatically by AnalyticsService.

    Declaration
    public virtual void Initialize(long timestampInMilliseconds, Dictionary<string, object> userData)
    Parameters
    Type Name Description
    Int64 timestampInMilliseconds
    Dictionary<String, Object> userData

    Inject(IResolver)

    Override this in derived event classes to get any required dependencies.

    Declaration
    public virtual void Inject(IResolver resolver)
    Parameters
    Type Name Description
    IResolver resolver

    Implements

    IAnalyticsEvent
    IInjectable
    Back to top Copyright © 2020 East Side Games Inc.