dotmailer SDK: dotMailer.Sdk.Objects.Contacts.DmSuppressedContact Class Reference

dotmailer SDK

dotmailer SDK
Tools to access and manage an account in the dotMailer system
dotMailer.Sdk.Objects.Contacts.DmSuppressedContact Class Reference

Represents a contact that has been suppressed More...

Inheritance diagram for dotMailer.Sdk.Objects.Contacts.DmSuppressedContact:
dotMailer.Sdk.Contacts.DmContact dotMailer.Sdk.Interfaces.IDmContact dotMailer.Sdk.Interfaces.IDmObject dotMailer.Sdk.Cache.IDmCacheableObject

Protected Member Functions

override DmDataFieldValueCollection LazyLoadDataFields ()
 NA
 
- Protected Member Functions inherited from dotMailer.Sdk.Contacts.DmContact
void SetDataFields (DmDataFieldValueCollection dataFields)
 Sets the data field value collection
 

Properties

DateTime DateSuppressed [get, set]
 Date that the contact was added to the suppression list
 
SuppressionCause SuppressionCause [get, set]
 The reason why the contact has been suppressed
 
override DmDataFieldValueCollection DataFields [get]
 NA
 
- Properties inherited from dotMailer.Sdk.Contacts.DmContact
int AccountId [get, set]
 The parent account id
 
int Id [get, set]
 The system Id of the contact
 
string Email [get, set]
 The contact email - this is read only from the database
 
string Notes [get, set]
 Contact Notes
 
EmailContentTypes EmailType [get, set]
 Email Type
 
EmailOptIn OptIn [get, set]
 Opt In Flag
 
ContactAudience Audience [get, set]
 Audience flag
 
string UserTag1 [get, set]
 User Tag
 
string UserTag2 [get, set]
 User Tag
 
string UserTag3 [get, set]
 User Tag
 
object this[string index] [get, set]
 Get the value of one of the data fields
 
virtual DmDataFieldValueCollection DataFields [get, set]
 Returns the collection of DataField Values
 
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
 
string FirstName [get, set]
 Gets/Sets the system data field FirstName
 
string Fullname [get, set]
 Gets/Sets the system data field Full name
 
string Gender [get, set]
 Gets/Sets the system data field Gender
 
string LastName [get, set]
 Gets/Sets the system data field Last name
 
string Postcode [get, set]
 Gets/Sets the system data field Post code
 
bool HasDataFields [get]
 Return true if the datafields have been loaded from the web service
 
- Properties inherited from dotMailer.Sdk.Interfaces.IDmContact
int Id [get]
 Gets the ID of the contact
 
string Email [get]
 Gets the email of the contact
 
ContactAudience Audience [get]
 Get the audience type
 
EmailContentTypes EmailType [get]
 Gets the email type
 
EmailOptIn OptIn [get]
 Gets the opt-in type for the contact
 
string Notes [get]
 gets the notes
 
DmDataFieldValueCollection DataFields [get]
 Gets and enumeration of the data fields for the contact
 
bool HasDataFields [get]
 Flag to indicate the datafields have been loaded
 
- 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
 

Additional Inherited Members

- Public Member Functions inherited from dotMailer.Sdk.Contacts.DmContact
ResubscribeContactResult Resubscribe (IDmAddressBook addressBook, string preferredLocale, string returnUrlToUseIfChallenged)
 re-subscribes a previously unsubscribed contact.
 
void SetContactEmail (string email)
 Sets the contact email address
 
void SetContactId (int newId)
 Sets the Id of the contact, only if it has not been set before
 
- Static Public Member Functions inherited from dotMailer.Sdk.Contacts.DmContact
static long CalculatePopulatedCrcHash (IDmContact iContact)
 returns the crc value for the populated fields
 
static List< string > GetPopulatedDataFieldNames (IDmContact iContact)
 Builds a list of the populated fields for an IDmContact interface
 

Detailed Description

Represents a contact that has been suppressed

Member Function Documentation

override DmDataFieldValueCollection dotMailer.Sdk.Objects.Contacts.DmSuppressedContact.LazyLoadDataFields ( )
protectedvirtual

NA

Returns

Reimplemented from dotMailer.Sdk.Contacts.DmContact.

Property Documentation

override DmDataFieldValueCollection dotMailer.Sdk.Objects.Contacts.DmSuppressedContact.DataFields
get

NA

DateTime dotMailer.Sdk.Objects.Contacts.DmSuppressedContact.DateSuppressed
getset

Date that the contact was added to the suppression list

SuppressionCause dotMailer.Sdk.Objects.Contacts.DmSuppressedContact.SuppressionCause
getset

The reason why the contact has been suppressed

Generated by   doxygen 1.8.3