Airship.Net
AirshipDotNet.Analytics.CustomEvent Class Reference

A Custom Event model object. More...

Public Member Functions

 CustomEvent (string name)
 Initializes a new instance of the CustomEvent class.
 
 CustomEvent (string name, double value)
 Initializes a new instance of the CustomEvent class.
 
void AddProperty (string name, string value)
 Adds a string property.
 
void AddProperty (string name, double value)
 Adds a double property.
 
void AddProperty (string name, bool value)
 Adds a bool property.
 
void AddProperty (string name, ICollection< string > value)
 Adds a string array property.
 

Properties

string EventName [get, set]
 Gets or sets the name of the event.
 
double? EventValue [get, set]
 Gets or sets the event value.
 
string? TransactionId [get, set]
 Gets or sets the transaction identifier.
 
string? InteractionType [get, set]
 Gets or sets the interaction type.
 
string? InteractionId [get, set]
 Gets or sets the interaction identifier.
 
List< IProperty > PropertyList [get]
 Gets a list of properties.
 

Detailed Description

A Custom Event model object.

Constructor & Destructor Documentation

◆ CustomEvent() [1/2]

AirshipDotNet.Analytics.CustomEvent.CustomEvent ( string name)
inline

Initializes a new instance of the CustomEvent class.

Parameters
nameThe name of the event.
valueThe event value.

◆ CustomEvent() [2/2]

AirshipDotNet.Analytics.CustomEvent.CustomEvent ( string name,
double value )
inline

Initializes a new instance of the CustomEvent class.

Parameters
nameThe name of the event.
valueThe event value.

Member Function Documentation

◆ AddProperty() [1/4]

void AirshipDotNet.Analytics.CustomEvent.AddProperty ( string name,
bool value )
inline

Adds a bool property.

Parameters
nameThe property name.
valueThe property value.

◆ AddProperty() [2/4]

void AirshipDotNet.Analytics.CustomEvent.AddProperty ( string name,
double value )
inline

Adds a double property.

Parameters
nameThe property name.
valueThe property value.

◆ AddProperty() [3/4]

void AirshipDotNet.Analytics.CustomEvent.AddProperty ( string name,
ICollection< string > value )
inline

Adds a string array property.

Parameters
nameThe property name.
valueThe property value.

◆ AddProperty() [4/4]

void AirshipDotNet.Analytics.CustomEvent.AddProperty ( string name,
string value )
inline

Adds a string property.

Parameters
nameThe property name.
valueThe property value.

Property Documentation

◆ EventName

string AirshipDotNet.Analytics.CustomEvent.EventName
getset

Gets or sets the name of the event.

The name of the event.

◆ EventValue

double? AirshipDotNet.Analytics.CustomEvent.EventValue
getset

Gets or sets the event value.

The event value.

◆ InteractionId

string? AirshipDotNet.Analytics.CustomEvent.InteractionId
getset

Gets or sets the interaction identifier.

The interaction identifier.

◆ InteractionType

string? AirshipDotNet.Analytics.CustomEvent.InteractionType
getset

Gets or sets the interaction type.

The interaction type.

◆ PropertyList

List<IProperty> AirshipDotNet.Analytics.CustomEvent.PropertyList
get

Gets a list of properties.

The property list.

◆ TransactionId

string? AirshipDotNet.Analytics.CustomEvent.TransactionId
getset

Gets or sets the transaction identifier.

The transaction identifier.