dotmailer SDK: dotMailer.Sdk.Campaigns.DmCampaignContactStats Class Reference

dotmailer SDK

dotmailer SDK
Tools to access and manage an account in the dotMailer system
dotMailer.Sdk.Campaigns.DmCampaignContactStats Class Reference

Class that encapsulates the contact activity/reports for a campaign More...

Inheritance diagram for dotMailer.Sdk.Campaigns.DmCampaignContactStats:
dotMailer.Sdk.Interfaces.IDmObject dotMailer.Sdk.Cache.IDmCacheableObject

Properties

int AccountId [get, set]
 The parent account id
 
int CampaignId [get, set]
 The parent Campaign id
 
string ContactEmail [get, set]
 The email address of the contact.
 
string Keyword [get, set]
 The label assigned to the link in the campaign.
 
DateTime DateClicked [get, set]
 The date and time the link was clicked.
 
string IpAddress [get, set]
 The IP address that the contact was using when they clicked the link.
 
Uri Url [get, set]
 The destination of the link that the contact clicked on.
 
string UserAgent [get, set]
 The user agent the contact was using the read the email when the link was clicked.
 
bool ForwardEstimates [get, set]
 The number of estimated forwards
 
string UserTag1 [get, set]
 User Tag
 
string UserTag2 [get, set]
 User Tag
 
string UserTag3 [get, set]
 User Tag
 
bool IsDirty [get]
 Returns true if the object has changed
 
string ObjectType [get, set]
 Returns the type name of the class Used by the serialisation process
 
string ExternalId [get]
 Gets/Sets the generated Id that uniquely identifies this record
 
DmCampaignContactPageViewCollection PageViews [get, set]
 Returns the page views collection Lazy Loaded - will call web service on first access
 
DmCampaignContactActivity Activity [get, set]
 Returns the contact activity collection Lazy Loaded - will call web service on first access
 
DmCampaignContactLinkClickCollection LinkClicks [get, set]
 Returns the lick clicks collection Lazy Loaded - will call web service on first access
 
DmCampaignContactOpenCollection Opens [get, set]
 Returns the opens collection Lazy Loaded - will call web service on first access
 
DmCampaignContactReplyCollection Replies [get, set]
 Returns the replies collection Lazy Loaded - will call web service on first access
 
DmCampaignContactRoiDetailCollection ContactsRoi [get, set]
 Returns the contact roi collection Lazy Loaded - will call web service on first access
 
DmCampaignContactSocialBookmarkCollection SocialBookmarks [get, set]
 Returns the Social Bookmarks collection Lazy Loaded - will call web service on first access
 
DmCampaignContactForward ForwardInfo [get, set]
 Returns the forward info collection Lazy Loaded - will call web service on first access
 
- Properties inherited from dotMailer.Sdk.Interfaces.IDmObject
int AccountId [get]
 The DotMailer account Id for this object
 
string ExternalId [get]
 A key that represents this object, used for synching with external applications
 
bool IsDirty [get]
 has the data of the object changed
 

Detailed Description

Class that encapsulates the contact activity/reports for a campaign

Property Documentation

int dotMailer.Sdk.Campaigns.DmCampaignContactStats.AccountId
getset

The parent account id

DmCampaignContactActivity dotMailer.Sdk.Campaigns.DmCampaignContactStats.Activity
getset

Returns the contact activity collection Lazy Loaded - will call web service on first access

int dotMailer.Sdk.Campaigns.DmCampaignContactStats.CampaignId
getset

The parent Campaign id

string dotMailer.Sdk.Campaigns.DmCampaignContactStats.ContactEmail
getset

The email address of the contact.

DmCampaignContactRoiDetailCollection dotMailer.Sdk.Campaigns.DmCampaignContactStats.ContactsRoi
getset

Returns the contact roi collection Lazy Loaded - will call web service on first access

DateTime dotMailer.Sdk.Campaigns.DmCampaignContactStats.DateClicked
getset

The date and time the link was clicked.

string dotMailer.Sdk.Campaigns.DmCampaignContactStats.ExternalId
get

Gets/Sets the generated Id that uniquely identifies this record

bool dotMailer.Sdk.Campaigns.DmCampaignContactStats.ForwardEstimates
getset

The number of estimated forwards

DmCampaignContactForward dotMailer.Sdk.Campaigns.DmCampaignContactStats.ForwardInfo
getset

Returns the forward info collection Lazy Loaded - will call web service on first access

string dotMailer.Sdk.Campaigns.DmCampaignContactStats.IpAddress
getset

The IP address that the contact was using when they clicked the link.

bool dotMailer.Sdk.Campaigns.DmCampaignContactStats.IsDirty
get

Returns true if the object has changed

string dotMailer.Sdk.Campaigns.DmCampaignContactStats.Keyword
getset

The label assigned to the link in the campaign.

DmCampaignContactLinkClickCollection dotMailer.Sdk.Campaigns.DmCampaignContactStats.LinkClicks
getset

Returns the lick clicks collection Lazy Loaded - will call web service on first access

string dotMailer.Sdk.Campaigns.DmCampaignContactStats.ObjectType
getset

Returns the type name of the class Used by the serialisation process

DmCampaignContactOpenCollection dotMailer.Sdk.Campaigns.DmCampaignContactStats.Opens
getset

Returns the opens collection Lazy Loaded - will call web service on first access

DmCampaignContactPageViewCollection dotMailer.Sdk.Campaigns.DmCampaignContactStats.PageViews
getset

Returns the page views collection Lazy Loaded - will call web service on first access

DmCampaignContactReplyCollection dotMailer.Sdk.Campaigns.DmCampaignContactStats.Replies
getset

Returns the replies collection Lazy Loaded - will call web service on first access

DmCampaignContactSocialBookmarkCollection dotMailer.Sdk.Campaigns.DmCampaignContactStats.SocialBookmarks
getset

Returns the Social Bookmarks collection Lazy Loaded - will call web service on first access

Uri dotMailer.Sdk.Campaigns.DmCampaignContactStats.Url
getset

The destination of the link that the contact clicked on.

string dotMailer.Sdk.Campaigns.DmCampaignContactStats.UserAgent
getset

The user agent the contact was using the read the email when the link was clicked.

string dotMailer.Sdk.Campaigns.DmCampaignContactStats.UserTag1
getset

User Tag

string dotMailer.Sdk.Campaigns.DmCampaignContactStats.UserTag2
getset

User Tag

string dotMailer.Sdk.Campaigns.DmCampaignContactStats.UserTag3
getset

User Tag

Generated by   doxygen 1.8.3