dotMailer.Sdk.Contacts.DmDocument Class Reference

Class that represents a document in dotMailer's Document Manager. More...

Inheritance diagram for dotMailer.Sdk.Contacts.DmDocument:

Public Member Functions
void	DetachFromCampaign (int campaignId)
	Removes this document from the attachments of the specified campaign.
void	DetachFromCampaign (DmCampaign campaign)
	Removes this document from the attachments of the specified campaign.
void	AttachToCampaign (int campaignId)
	Attaches this document to the specified campaign. This document must be uploaded prior to attachment.
void	AttachToCampaign (DmCampaign campaign)
	Attaches this document to the specified campaign. This document must be uploaded prior to attachment.

Properties
string	ObjectType [get, set]
	Returns the type name of the class Used by the serialisation process
bool	IsDirty [get]
	Returns true if the object has changed
string	ExternalId [get]
	Gets/Sets the generated Id that uniquely identifies this record
int	AccountId [get, set]
	Returns the dotMailer account Id for this document
int	Id [get, set]
	The identifier for document.
string	Name [get, set]
	The name of the document.
string	FileName [get, set]
	The filename for the document.
int	FileSize [get, set]
	The filesize of the document.
DateTime	DateCreated [get, set]
	The date and time the document was added to the system.
DateTime	DateModified [get, set]
	The date and time the document was last modified in the system.
string	UserTag1 [get, set]
	User Tag
string	UserTag2 [get, set]
	User Tag
string	UserTag3 [get, set]
	User Tag
Properties inherited from dotMailer.Sdk.Interfaces.IDmDocument
int	Id [get]
	The identifier for document.
string	Name [get]
	The name of the document.
string	FileName [get]
	The filename for the document.
int	FileSize [get]
	The filesize of the document.
System.DateTime	DateCreated [get]
	The date and time the document was added to the system.
System.DateTime	DateModified [get]
	The date and time the document was last modified in the system.
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 represents a document in dotMailer's Document Manager.

Member Function Documentation

void dotMailer.Sdk.Contacts.DmDocument.AttachToCampaign

(

int

campaignId

)

Attaches this document to the specified campaign. This document must be uploaded prior to attachment.

Parameters

campaignId

The ID of the campaign to which this document will be attached.

void dotMailer.Sdk.Contacts.DmDocument.AttachToCampaign

(

DmCampaign

campaign

)

Attaches this document to the specified campaign. This document must be uploaded prior to attachment.

Parameters

campaign

The campaign to which this document will be attached.

void dotMailer.Sdk.Contacts.DmDocument.DetachFromCampaign

(

int

campaignId

)

Removes this document from the attachments of the specified campaign.

Parameters

campaignId

The ID of the campaign from which to remove this document.

void dotMailer.Sdk.Contacts.DmDocument.DetachFromCampaign

(

DmCampaign

campaign

)

Removes this document from the attachments of the specified campaign.

Parameters

campaign

The campaign from which to remove this document.

Property Documentation

int dotMailer.Sdk.Contacts.DmDocument.AccountId

getset

Returns the dotMailer account Id for this document

DateTime dotMailer.Sdk.Contacts.DmDocument.DateCreated

getset

The date and time the document was added to the system.

DateTime dotMailer.Sdk.Contacts.DmDocument.DateModified

getset

The date and time the document was last modified in the system.

string dotMailer.Sdk.Contacts.DmDocument.ExternalId

get

Gets/Sets the generated Id that uniquely identifies this record

string dotMailer.Sdk.Contacts.DmDocument.FileName

getset

The filename for the document.

int dotMailer.Sdk.Contacts.DmDocument.FileSize

getset

The filesize of the document.

int dotMailer.Sdk.Contacts.DmDocument.Id

getset

The identifier for document.

bool dotMailer.Sdk.Contacts.DmDocument.IsDirty

get

Returns true if the object has changed

string dotMailer.Sdk.Contacts.DmDocument.Name

getset

The name of the document.

string dotMailer.Sdk.Contacts.DmDocument.ObjectType

getset

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

string dotMailer.Sdk.Contacts.DmDocument.UserTag1

getset

User Tag

string dotMailer.Sdk.Contacts.DmDocument.UserTag2

getset

User Tag

string dotMailer.Sdk.Contacts.DmDocument.UserTag3

getset

User Tag