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

dotmailer SDK

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

Represents an APICampaignContactOpen returned by the ListCampaignContactOpens web method More...

Inheritance diagram for dotMailer.Sdk.Campaigns.DmCampaignContactOpen:
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
 
int ContactId [get, set]
 The id of the contact
 
string ContactEmail [get, set]
 The email of the contact
 
string IpAddress [get, set]
 The IP address that the contact was using when they opened the email.
 
string UserAgent [get, set]
 The user agent the contact was using to open the email.
 
bool IsHtml [get, set]
 Whether the campaign that was opened was the HTML one (TRUE) or Plain Text (FALSE).
 
bool IsForward [get, set]
 Whether the open was from a forward (TRUE) or not (FALSE).
 
DateTime DateOpened [get, set]
 The date and time the link was clicked.
 
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. Note: In some cases, more than one open can share identical property values. Where this occurs, external IDs are also identical.
 
- 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 APICampaignContactOpen returned by the ListCampaignContactOpens web method

Property Documentation

int dotMailer.Sdk.Campaigns.DmCampaignContactOpen.AccountId
getset

The parent account id

int dotMailer.Sdk.Campaigns.DmCampaignContactOpen.CampaignId
getset

The parent campaign id

string dotMailer.Sdk.Campaigns.DmCampaignContactOpen.ContactEmail
getset

The email of the contact

int dotMailer.Sdk.Campaigns.DmCampaignContactOpen.ContactId
getset

The id of the contact

DateTime dotMailer.Sdk.Campaigns.DmCampaignContactOpen.DateOpened
getset

The date and time the link was clicked.

string dotMailer.Sdk.Campaigns.DmCampaignContactOpen.ExternalId
get

Gets/Sets the generated Id that uniquely identifies this record. Note: In some cases, more than one open can share identical property values. Where this occurs, external IDs are also identical.

string dotMailer.Sdk.Campaigns.DmCampaignContactOpen.IpAddress
getset

The IP address that the contact was using when they opened the email.

bool dotMailer.Sdk.Campaigns.DmCampaignContactOpen.IsDirty
get

Returns true if the object has changed

bool dotMailer.Sdk.Campaigns.DmCampaignContactOpen.IsForward
getset

Whether the open was from a forward (TRUE) or not (FALSE).

bool dotMailer.Sdk.Campaigns.DmCampaignContactOpen.IsHtml
getset

Whether the campaign that was opened was the HTML one (TRUE) or Plain Text (FALSE).

string dotMailer.Sdk.Campaigns.DmCampaignContactOpen.ObjectType
getset

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

string dotMailer.Sdk.Campaigns.DmCampaignContactOpen.UserAgent
getset

The user agent the contact was using to open the email.

string dotMailer.Sdk.Campaigns.DmCampaignContactOpen.UserTag1
getset

User Tag

string dotMailer.Sdk.Campaigns.DmCampaignContactOpen.UserTag2
getset

User Tag

string dotMailer.Sdk.Campaigns.DmCampaignContactOpen.UserTag3
getset

User Tag

Generated by   doxygen 1.8.3