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

dotmailer SDK

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

Represents an APICampaignContactSummary returned by the ListCampaignContactActivity web method More...

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

Properties

int AccountId [get, set]
 The dotMailer account id
 
int CampaignId [get, set]
 The owner campaign id
 
string ContactEmail [get, set]
 The email address of the contact.
 
int NumOpens [get, set]
 The number of times the contact has been tracked as having opened the campaign
 
int NumClicks [get, set]
 The number times the user has been tracked as having clicked on a link in the campaign.
 
bool Unsubscribed [get, set]
 Whether or not the campaign triggered the user to unsubscribe.
 
int NumViews [get, set]
 The number of website page views tracked following a click in the campaign if you are using dotMailer page tracking on your site.
 
int NumEstimatedForwards [get, set]
 The estimated number of times the contact forwarded the campaign (and it was subsequently opened).
 
int NumForwardToFriend [get, set]
 The number of addresses the contact used the "Forward to a Friend" link and functionality for.
 
int NumReplies [get, set]
 The number of replies received to the campaign sent to that contact.
 
int ContactId [get, set]
 Id of DmContact
 
DateTime DateFirstOpened [get, set]
 The date and time of the first tracked open of the campaign for the contact.
 
DateTime DateLastOpened [get, set]
 The date and time of the most recent tracked open of the campaign for the contact.
 
DateTime DateSent [get, set]
 The date and time the campaign was sent to the contact. If it has been sent to the contact more than once, this is the most recent date and time it was sent.
 
string FirstOpenIp [get, set]
 The IP address the contact was first tracked as having opened the campaign at.
 
string FirstOpenUserAgent [get, set]
 This element is a legacy feature and will be returned empty.
 
bool SoftBounced [get, set]
 Whether or not a soft bounce was received for the contact for this campaign.
 
bool HardBounced [get, set]
 Whether or not a hard bounce was received for the contact for this campaign.
 
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
 
- 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

Represents an APICampaignContactSummary returned by the ListCampaignContactActivity web method

Property Documentation

int dotMailer.Sdk.Campaigns.DmCampaignContactActivity.AccountId
getset

The dotMailer account id

int dotMailer.Sdk.Campaigns.DmCampaignContactActivity.CampaignId
getset

The owner campaign id

string dotMailer.Sdk.Campaigns.DmCampaignContactActivity.ContactEmail
getset

The email address of the contact.

int dotMailer.Sdk.Campaigns.DmCampaignContactActivity.ContactId
getset

Id of DmContact

DateTime dotMailer.Sdk.Campaigns.DmCampaignContactActivity.DateFirstOpened
getset

The date and time of the first tracked open of the campaign for the contact.

DateTime dotMailer.Sdk.Campaigns.DmCampaignContactActivity.DateLastOpened
getset

The date and time of the most recent tracked open of the campaign for the contact.

DateTime dotMailer.Sdk.Campaigns.DmCampaignContactActivity.DateSent
getset

The date and time the campaign was sent to the contact. If it has been sent to the contact more than once, this is the most recent date and time it was sent.

string dotMailer.Sdk.Campaigns.DmCampaignContactActivity.ExternalId
get

Gets/Sets the generated Id that uniquely identifies this record

string dotMailer.Sdk.Campaigns.DmCampaignContactActivity.FirstOpenIp
getset

The IP address the contact was first tracked as having opened the campaign at.

string dotMailer.Sdk.Campaigns.DmCampaignContactActivity.FirstOpenUserAgent
getset

This element is a legacy feature and will be returned empty.

bool dotMailer.Sdk.Campaigns.DmCampaignContactActivity.HardBounced
getset

Whether or not a hard bounce was received for the contact for this campaign.

bool dotMailer.Sdk.Campaigns.DmCampaignContactActivity.IsDirty
get

Returns true if the object has changed

int dotMailer.Sdk.Campaigns.DmCampaignContactActivity.NumClicks
getset

The number times the user has been tracked as having clicked on a link in the campaign.

int dotMailer.Sdk.Campaigns.DmCampaignContactActivity.NumEstimatedForwards
getset

The estimated number of times the contact forwarded the campaign (and it was subsequently opened).

int dotMailer.Sdk.Campaigns.DmCampaignContactActivity.NumForwardToFriend
getset

The number of addresses the contact used the "Forward to a Friend" link and functionality for.

int dotMailer.Sdk.Campaigns.DmCampaignContactActivity.NumOpens
getset

The number of times the contact has been tracked as having opened the campaign

int dotMailer.Sdk.Campaigns.DmCampaignContactActivity.NumReplies
getset

The number of replies received to the campaign sent to that contact.

int dotMailer.Sdk.Campaigns.DmCampaignContactActivity.NumViews
getset

The number of website page views tracked following a click in the campaign if you are using dotMailer page tracking on your site.

string dotMailer.Sdk.Campaigns.DmCampaignContactActivity.ObjectType
getset

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

bool dotMailer.Sdk.Campaigns.DmCampaignContactActivity.SoftBounced
getset

Whether or not a soft bounce was received for the contact for this campaign.

bool dotMailer.Sdk.Campaigns.DmCampaignContactActivity.Unsubscribed
getset

Whether or not the campaign triggered the user to unsubscribe.

string dotMailer.Sdk.Campaigns.DmCampaignContactActivity.UserTag1
getset

User Tag

string dotMailer.Sdk.Campaigns.DmCampaignContactActivity.UserTag2
getset

User Tag

string dotMailer.Sdk.Campaigns.DmCampaignContactActivity.UserTag3
getset

User Tag

Generated by   doxygen 1.8.3