Show / Hide Table of Contents

    Namespace IdleKit.Analytics

    Classes

    ABTestEvent

    Send when a user is first assigned a test group for an ongoing A/B Test.

    AchievementEvent

    Send when a user completes an achievement.

    AdHocEvent

    note: Fires an 'action' event, not an 'adHoc' event. Renamed to avoid confusion with IdleKit actions Catch-all type of event. Various actions are defined by an analyst.

    AnalyticsDispatcherBase<TDispatcherConfig>

    AnalyticsDispatcherConfigBase

    AnalyticsDispatcherConfigReference

    AnalyticsEnvironmentConfig

    AnalyticsEnvironmentConfigAsset

    AnalyticsEnvironmentConfigMissingException

    AnalyticsEnvironmentConfigReference

    AnalyticsEnvironmentMissingException

    AnalyticsEventBase

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

    AnalyticsEventInitializationException

    AnalyticsImmediateDispatcherBase<TDispatcherConfig>

    AnalyticsInstaller

    AnalyticsIntervalDispatcherBase<TDispatcherConfig>

    AnalyticsIntervalDispatcherConfigBase

    AnalyticsLogging

    AnalyticsService

    This service provides support for sending analytics events to one or more endpoints. The application will log an IAnalyticsEvent through this API and the event will be passed to the IAnalyticsDispatcher objects that have been added through the configuration. Exceptions and session related events will also be caught and logged automatically.

    AnalyticsUserDataMissingException

    ContentSummaryEvent

    Used to track summary data for content completion.

    CurrencyEvent

    Track when user's receive or spend currency.

    DebugDispatcher

    This dispatcher outputs IAnalyticsEvent objects to the console in the Unity Editor. It's not recommended to include this dispatcher in any production configuration.

    DebugDispatcherConfig

    DebugDispatcherConfigAsset

    DialogSequenceEvent

    Track when the user sees dialog screens for story sequences.

    DownloadPromptEvent

    Track when the user has been prompted with a game data download.

    ErrorEvent

    This should be sent any time an exception or other error happens.

    GachaOpenedEvent

    Track when the user has opened gacha and what their reward was.

    GachaRewardEntry

    A reward entry indicates an item and an amount received from gacha. Generally used for integral rewards instead of game currency.

    InstallEvent

    This should be sent once per user when they load the game for the first time.

    KraangUserDataBase

    A collection of common user data. Kraang expects id and level in every event. This needs to be extended in order for the fields to be populated with data.

    PlayerDataEvent

    This event just wraps an IAnalyticsUserData to allow for updates involving that data to be sent to analytics endpoints.

    PurchaseEvent

    Send when a user makes a purchase using real currency.

    PurchaseFailedEvent

    Send when an attempted purchase using real money fails.

    PushNotificationEvent

    Send when a push notification is sent, if possible, or cache some data and send this event when the user opens the app after a notification has been sent.

    QuestProgressionEvent

    Send to track details about when a user begins or finishes a quest or quest-like activity such as goals or milestones.

    SessionBeginEvent

    This event is used to track the start of a users session. It should not be sent until the users id and level have been loaded. Use other events like AdHocEvent to track load flow. This event works in tandem with SessionEndEvent and should be sent on app start and any time the app is brought into focus from the background.

    SessionEndEvent

    This event is used to track the end of a users session. This event works in tandem with SessionBeginEvent and should be sent any time the app is sent to the background.

    Interfaces

    IAnalyticsDispatcher

    Each dispatcher is responsible for outputting IAnalyticsEvents. This may be to the console, or to an endpoint.

    IAnalyticsDispatcherConfig

    Configuration for an IAnalyticsDispatcher.

    IAnalyticsEnvironmentConfig

    Allows each IEnvironmentConfig to have a different set of IAnalyticsDispatchers.

    IAnalyticsEvent

    A collection of data that is formatted and sent to an IngestionEndpoint by the IAnalyticsService.

    IAnalyticsIntervalDispatcherConfig

    Configuration for an IAnalyticsDispatcher that should send events periodically.

    IAnalyticsService

    This IService is used to log IAnalyticsEvents for data analysts. Events that are logged via this service will be sent along to any instantiated IAnalyticsDispatchers for custom parsing / output.

    IAnalyticsUserData

    A subset of data that is appended to every IAnalyticsEvent.

    Enums

    CurrencyCategory

    Categories representing where currencies can exist within a game.

    CurrencyFlow

    Directions that currency can flow involving the user.

    QuestProgressionState

    Back to top Copyright © 2020 East Side Games Inc.