Represents the result of an import contact operation. Can be used to track the progress of an import, and provides stats for the results of the import. More...

Inheritance diagram for dotMailer.Sdk.Contacts.Importing.ImportContactResult:

Public Member Functions
ImportWatcher	GetImportWatcher ()
	Gets the an import watcher that can be used to watch for this import to be complete.

ImportWatcher	GetImportWatcher (TimeSpan watchInterval)
	Gets the an import watcher that can be used to watch for this import to be complete

List< ContactImportStatus >	SessionStatus ()
	Returns a list of the import status for each session that was used to

Properties
int	AccountId `[get, set]`
	The parent account id

DateTime	ImportDateTime `[get, set]`
	The DateTime (UTC) that the import result was created

int	AddressBookId `[get, set]`
	Id of the address book that the contacts were imported into

ImportType	ImportType `[get, set]`
	The type of the import

string	UserTag1 `[get, set]`
	User Tag

string	UserTag2 `[get, set]`
	User Tag

string	UserTag3 `[get, set]`
	User Tag

ImportContactSessionCollection	Sessions `[get, set]`
	The import sessions

ImportReport	ImportReport `[get]`
	Returns the import report

ImportContactOptions	ImportOptions `[get, set]`
	The import options that were used to import the contacts

bool	Completed `[get]`
	Returns true if the import is completed with or without errors

AddContactResultStatus	Status `[get]`
	Returns the status of the add result

int	PercentageComplete `[get]`
	Returns the percentage of the completed contacts

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

bool	HasFaultedEmailAddresses `[get]`
	Does the report contain any email address that have failed

IEnumerable< string >	FaultedEmailAddresses `[get]`
	Returns a list of the email addresses that were rejected

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 the result of an import contact operation. Can be used to track the progress of an import, and provides stats for the results of the import.

Member Function Documentation

ImportWatcher dotMailer.Sdk.Contacts.Importing.ImportContactResult.GetImportWatcher ( )

Gets the an import watcher that can be used to watch for this import to be complete.

The caller is responsible for disposing of the returned watcher.

Returns: ImportWatcher

ImportWatcher dotMailer.Sdk.Contacts.Importing.ImportContactResult.GetImportWatcher ( TimeSpan watchInterval )

Gets the an import watcher that can be used to watch for this import to be complete

Caller is responsible for disposing watcher

Parameters

watchInterval time to wait between polls

Returns: ImportWatcher

List<ContactImportStatus> dotMailer.Sdk.Contacts.Importing.ImportContactResult.SessionStatus ( )

Returns a list of the import status for each session that was used to

Returns

Property Documentation

int dotMailer.Sdk.Contacts.Importing.ImportContactResult.AccountId

getset

The parent account id

int dotMailer.Sdk.Contacts.Importing.ImportContactResult.AddressBookId

getset

Id of the address book that the contacts were imported into

bool dotMailer.Sdk.Contacts.Importing.ImportContactResult.Completed

get

Returns true if the import is completed with or without errors

string dotMailer.Sdk.Contacts.Importing.ImportContactResult.ExternalId

get

Gets/Sets the generated Id that uniquely identifies this record

IEnumerable<string> dotMailer.Sdk.Contacts.Importing.ImportContactResult.FaultedEmailAddresses

get

Returns a list of the email addresses that were rejected

bool dotMailer.Sdk.Contacts.Importing.ImportContactResult.HasFaultedEmailAddresses

get

Does the report contain any email address that have failed

DateTime dotMailer.Sdk.Contacts.Importing.ImportContactResult.ImportDateTime

getset

The DateTime (UTC) that the import result was created

ImportContactOptions dotMailer.Sdk.Contacts.Importing.ImportContactResult.ImportOptions

getset

The import options that were used to import the contacts

ImportReport dotMailer.Sdk.Contacts.Importing.ImportContactResult.ImportReport

get

Returns the import report

ImportType dotMailer.Sdk.Contacts.Importing.ImportContactResult.ImportType

getset

The type of the import

bool dotMailer.Sdk.Contacts.Importing.ImportContactResult.IsDirty

get

Returns true if the object has changed

string dotMailer.Sdk.Contacts.Importing.ImportContactResult.ObjectType

getset

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

int dotMailer.Sdk.Contacts.Importing.ImportContactResult.PercentageComplete

get

Returns the percentage of the completed contacts

ImportContactSessionCollection dotMailer.Sdk.Contacts.Importing.ImportContactResult.Sessions

getset

The import sessions

AddContactResultStatus dotMailer.Sdk.Contacts.Importing.ImportContactResult.Status

get

Returns the status of the add result

string dotMailer.Sdk.Contacts.Importing.ImportContactResult.UserTag1

getset

User Tag

string dotMailer.Sdk.Contacts.Importing.ImportContactResult.UserTag2

getset

User Tag

string dotMailer.Sdk.Contacts.Importing.ImportContactResult.UserTag3

getset

User Tag

dotmailer SDK: dotMailer.Sdk.Contacts.Importing.ImportContactResult Class Reference

dotmailer SDK

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation

Get in touch