Class Activity

An activity is a collection of several activity events. When recording event, it's a good habit to group them per activity. One activity can be a single UI panel, for instance. Within that activity, you can record multiple events, such as where the user clicks and when.

Inheritance
System.Object
Activity
AppPanelActivity
ViewArExperienceActivity
Analytics_AddSessionActivity.PostData
BaseActivityHelper
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Appearition.Analytics
Assembly: Appearition.SDK.dll
Syntax
[Serializable]
public class Activity : IDisposable

Constructors

View Source

Activity()

Declaration
protected Activity()
View Source

Activity(String, String)

Declaration
public Activity(string sessionKey, string activityCode)
Parameters
Type Name Description
System.String sessionKey
System.String activityCode

Fields

View Source

ActivityCode

Declaration
public string ActivityCode
Field Value
Type Description
System.String
View Source

ActivityData

Declaration
public List<AnalyticsData> ActivityData
Field Value
Type Description
System.Collections.Generic.List<AnalyticsData>
View Source

ActivityKey

Declaration
public string ActivityKey
Field Value
Type Description
System.String
View Source

EndUtcDateTime

Declaration
public string EndUtcDateTime
Field Value
Type Description
System.String
View Source

Events

Declaration
public List<ActivityEvent> Events
Field Value
Type Description
System.Collections.Generic.List<ActivityEvent>
View Source

SessionKey

Declaration
public string SessionKey
Field Value
Type Description
System.String
View Source

StartUtcDateTime

Declaration
public string StartUtcDateTime
Field Value
Type Description
System.String

Properties

View Source

DefaultActivityCode

Declaration
protected virtual string DefaultActivityCode { get; }
Property Value
Type Description
System.String
View Source

EndDateTime

Declaration
public DateTime EndDateTime { get; }
Property Value
Type Description
System.DateTime
View Source

IsSubmitted

Declaration
protected bool IsSubmitted { get; set; }
Property Value
Type Description
System.Boolean
View Source

StartDateTime

Declaration
public DateTime StartDateTime { get; }
Property Value
Type Description
System.DateTime

Methods

View Source

AddEventToActivity(ActivityEvent)

Add a new activity event to this activity.

Declaration
public void AddEventToActivity(ActivityEvent newEvent)
Parameters
Type Name Description
ActivityEvent newEvent
View Source

AddEventToActivity<T>(Activity.ActivityEventContainer<T>)

Add a new activity event to this activity.

Declaration
public void AddEventToActivity<T>(Activity.ActivityEventContainer<T> newEventContainer)
    where T : Activity.ActivityEventContainer<T>
Parameters
Type Name Description
Activity.ActivityEventContainer<T> newEventContainer
Type Parameters
Name Description
T
View Source

ConvertStringToCodeFormat(String)

Converts a string to a ActivityCode or EventCode format. eg WhateverString -> WHATEVER_STRING

Declaration
protected static string ConvertStringToCodeFormat(string input)
Parameters
Type Name Description
System.String input
Returns
Type Description
System.String
View Source

Dispose()

Declaration
public void Dispose()
View Source

FinalizeActivityCreation()

Finalizes the activity creation and stores this current activity in the ongoing session. If creating custom activities, make sure to call this method at the end of the creation process.

Declaration
protected void FinalizeActivityCreation()
View Source

GetLastActivityWithTimestamp()

Returns the last entered event which contains a timestamp, if any.

Declaration
public ActivityEvent GetLastActivityWithTimestamp()
Returns
Type Description
ActivityEvent
View Source

SubmitActivity()

Finalizes, closes and adds this activity to the current session to be submitted.

Declaration
public virtual void SubmitActivity()

Implements

System.IDisposable

Extension Methods