A helper class that encapsulates a document that is to be attached to a TRIM object. More...

Inheritance diagram for HP.HPTRIM.SDK.InputDocument:

Public Member Functions
	InputDocument ()
	Constructs an input document. More...

	InputDocument (string fileName)
	Constructs an input document based on the nominated operating system file name. More...

	InputDocument (string emailSubject, string emailContent, TrimDateTime sentDate, TrimDateTime receivedDate, bool timesAreUniversal)
	Constructs an input document based on an email message. More...

	InputDocument (ElectronicStore alreadyInStore, string alreadyInStoreID, long alreadyInStoreBytes, string alreadyInStoreExtension)
	Constructs an input document corresponding to a pre-existing item in an external store. Note that this does not allow multiple references to a single stored item - TRIM does not support single instancing in this way. More...

	InputDocument (OfflineRecord offlineRecordToSetAs, bool updateAfterCheckIn)
	Constructs an input document corresponding to an item in the TRIM offline records folder. More...

void	AddAttachment (string inputFile, string displayName)
	Adds the nominated file as an attachment of the mail message of this Input Document, if it is a mail message. More...

void	AddAttachment (EmailAttachment attachedItem)
	Adds the attachment object as an attachment of the mail message of this Input Document, More...

EmailAttachmentList	GetAttachments ()
	Gets all the attachments associated with this InputDocument More...

void	AddRecipient (MailRecipientType RecipientType, string mailAddress, string displayName, string mailType)
	Adds the person described by the nominated email address and display name to the 'To', 'Cc' or 'Bcc' field of the mail message, if this InputDocument is a mail message. More...

void	AddRecipient (MailRecipientType recipientType, EmailParticipant mailRecipient)
	Adds the person described by the EmailParticipant object to the 'To' , 'Cc' or 'Bcc' field of the mail message, if this InputDocument is a mail message. More...

EmailParticipantList	GetRecipients (MailRecipientType recipientType)
	Gets the author iof this email message as an EmailParticipant object More...

void	SetAuthor (string mailAddress, string displayName, string mailType)
	Sets the person described by the nominated email address and display name as the Author of the mail message, if this InputDocument is a mail message. More...

void	SetAuthor (EmailParticipant newAuthor)
	Sets the person described by the nominated EmailParticipant as the Author of the mail message, if this InputDocument is a mail message. More...

EmailParticipant	GetAuthor ()
	Gets the author iof this email message as an EmailParticipant object More...

void	CleanupMailFiles ()
	Removes all attachment and native mail message files, as well as any temporary file associated with this InputDocument from the hard disk. More...

void	SetAsFile (string fileName)
	Sets the Input Document to correspond to the document at the nominated file path More...

void	SetAsMailMessage (string subject, string content, TrimDateTime sent, TrimDateTime received)
	Sets the Input Document to be of a TRIM mail message format (a .vmbx file). The supplied parameters should match the original email message fields and will be used in this Input Document object. More...

void	SetAsMailMessage ()
	Sets the Input Document to be of a TRIM mail message format (a .vmbx file). The various fields of the original email message should be copied to the corresponding fields on this Input Document object. More...

void	SetAsAlreadyStoredItem (ElectronicStore alreadyInStore, string alreadyInStoreID, long alreadyInStoreBytes, string alreadyInStoreExtension)
	Sets the Input Document to correspond to a document that has already been stored in a TRIM document store. Note that this does not allow multiple references to a single stored item - TRIM does not support single instancing in this way. More...

void	SetAsOfflineRecord (OfflineRecord offlineRecordToSetAs, bool UpdateAfterCheckIn)
	Sets the InputDocument from an Offline Record More...

Public Member Functions inherited from HP.HPTRIM.SDK.TrimSDKObject
	TrimSDKObject ()

Properties
string	Name `[get]`
	Gets a string containing a descriptive title for this InputDocument object. More...

bool	IsMailMessage `[get]`
	Gets a Boolean value indicating whether this InputDocument is a mail message More...

bool	TimesAreUniversal `[get, set]`
	Gets or sets a Boolean value indicating whether the times of the 'SentDate' and 'ReceivedDate' properties of this InputDocument are based on Universal Time Coordinates / Greenwich Mean Time. More...

string	Subject `[get, set]`
	Gets or sets a string containing the subject of the mail message, if this InputDocument is a mail message. More...

string	MessageId `[get, set]`
	Gets or sets a string containing the unique message id of the mail message, if this InputDocument is a mail message. More...

string	ConversationId `[get, set]`
	Gets or sets a string containing the conversation id of the mail message, if this InputDocument is a mail message. More...

string	Content `[get, set]`
	Gets or sets a string containing the body (main content) of the mail message, if this InputDocument is a mail message More...

TrimDateTime	SentDate `[get, set]`
	Gets or sets the date the mail message was sent, if this InputDocument is a mail message More...

TrimDateTime	ReceivedDate `[get, set]`
	Gets or sets the date this mail message was received, if this InputDocument is a mail message More...

string	NativeMailFile `[get, set]`
	Gets or sets a string containing the file path to the native mail file for this mail message, if this InputDocument is a mail message. More...

bool	HasAttachments `[get, set]`
	Gets or sets a boolean value indicating whether the email message has attachments. If you are passing a native email file such as .msg or .eml, this allows you to indicate the email has attachments without having to extract them and pass them into AddAttachment More...

bool	IsExternalStoreItem `[get]`

string	ExternalStoreId `[get]`
	No longer used. More...

string	ExternalExtension `[get]`
	No longer used. More...

bool	IsAlreadyInStore `[get]`
	Gets a boolean value indicating whether this inputDocument represents an item that has already stored in a TRIM document store. Note that this does not allow multiple references to a single item - TRIM does not support single instancing in this way. More...

TrimURI	AlreadyInStoreUri `[get]`
	Gets a Int64 value indicating the URI of the store that this input document is already stored in. Only relevant if IsAlreadyInStore is true. More...

string	AlreadyInStoreID `[get]`
	Gets a String value indicating the store ID that this input document is already stored as. Only relevant if IsAlreadyInStore is true. More...

string	AlreadyInStoreExtension `[get]`
	Gets a String value indicating the extension of an "already stored" item. Only relevant if IsAlreadyInStore is true. More...

long	AlreadyInStoreSize `[get]`
	Gets an Int64 value indicating the size (in bytes) of an "already stored" item. Only relevant if IsAlreadyInStore is true. More...

OfflineRecord	OfflineRecord `[get]`
	Gets the Offline Record object associated with this document. More...

bool	IsOfflineRecord `[get]`
	Gets a boolean value indicating whether this document is an Offline Record. More...

string	CheckinAs `[get, set]`
	Gets or sets a string containing the checkin path as it is to be remembered in Content Manager More...

bool	UpdateOfflineRecord `[get]`
	Gets a Boolean value indicating whether the offline record should be updated or removed as part of the check in process More...

string	LocalFile `[get]`
	Gets a string containing the path to the document corresponding to this Input Document. If this InputDocument is a mail message, this is the path to the .vmbx file created through this InputDocument object. More...

string	VerificationHash `[get, set]`
	Gets or sets a 64-byte MD5 hash of the document that can be used for end to end verification. When the document is submitted to the record this hash will be checked for validity, allowing an end-to-end verification mechanism to be established. For compatibility, you can calculated this hash using the Database.CalculateDocumentHash function. More...

Properties inherited from HP.HPTRIM.SDK.TrimSDKObject
string	ErrorMessage `[get]`
	All TRIM SDK objects have an ErrorMessage property which can be used to examine any error that may have occurred in the most recent method call. More...

TrimException	Error `[get]`
	All TRIM SDK objects have an Error property which can be used to examine any error that may have occurred in the most recent method call. More...

Detailed Description

A helper class that encapsulates a document that is to be attached to a TRIM object.

Constructor & Destructor Documentation

HP.HPTRIM.SDK.InputDocument.InputDocument ( )

Constructs an input document.

HP.HPTRIM.SDK.InputDocument.InputDocument ( string fileName )

Constructs an input document based on the nominated operating system file name.

HP.HPTRIM.SDK.InputDocument.InputDocument	(	string	emailSubject,
		string	emailContent,
		TrimDateTime	sentDate,
		TrimDateTime	receivedDate,
		bool	timesAreUniversal
	)

Constructs an input document based on an email message.

HP.HPTRIM.SDK.InputDocument.InputDocument	(	ElectronicStore	alreadyInStore,
		string	alreadyInStoreID,
		long	alreadyInStoreBytes,
		string	alreadyInStoreExtension
	)

Constructs an input document corresponding to a pre-existing item in an external store. Note that this does not allow multiple references to a single stored item - TRIM does not support single instancing in this way.

HP.HPTRIM.SDK.InputDocument.InputDocument	(	OfflineRecord	offlineRecordToSetAs,
		bool	updateAfterCheckIn
	)

Constructs an input document corresponding to an item in the TRIM offline records folder.

Member Function Documentation

void HP.HPTRIM.SDK.InputDocument.AddAttachment	(	string	inputFile,
		string	displayName
	)

Adds the nominated file as an attachment of the mail message of this Input Document, if it is a mail message.

void HP.HPTRIM.SDK.InputDocument.AddAttachment ( EmailAttachment attachedItem )

Adds the attachment object as an attachment of the mail message of this Input Document,

void HP.HPTRIM.SDK.InputDocument.AddRecipient	(	MailRecipientType	RecipientType,
		string	mailAddress,
		string	displayName,
		string	mailType
	)

Adds the person described by the nominated email address and display name to the 'To', 'Cc' or 'Bcc' field of the mail message, if this InputDocument is a mail message.

void HP.HPTRIM.SDK.InputDocument.AddRecipient	(	MailRecipientType	recipientType,
		EmailParticipant	mailRecipient
	)

Adds the person described by the EmailParticipant object to the 'To' , 'Cc' or 'Bcc' field of the mail message, if this InputDocument is a mail message.

void HP.HPTRIM.SDK.InputDocument.CleanupMailFiles ( )

Removes all attachment and native mail message files, as well as any temporary file associated with this InputDocument from the hard disk.

EmailAttachmentList HP.HPTRIM.SDK.InputDocument.GetAttachments ( )

Gets all the attachments associated with this InputDocument

EmailParticipant HP.HPTRIM.SDK.InputDocument.GetAuthor ( )

Gets the author iof this email message as an EmailParticipant object

EmailParticipantList HP.HPTRIM.SDK.InputDocument.GetRecipients ( MailRecipientType recipientType )

Gets the author iof this email message as an EmailParticipant object

void HP.HPTRIM.SDK.InputDocument.SetAsAlreadyStoredItem	(	ElectronicStore	alreadyInStore,
		string	alreadyInStoreID,
		long	alreadyInStoreBytes,
		string	alreadyInStoreExtension
	)

Sets the Input Document to correspond to a document that has already been stored in a TRIM document store. Note that this does not allow multiple references to a single stored item - TRIM does not support single instancing in this way.

void HP.HPTRIM.SDK.InputDocument.SetAsFile ( string fileName )

Sets the Input Document to correspond to the document at the nominated file path

void HP.HPTRIM.SDK.InputDocument.SetAsMailMessage	(	string	subject,
		string	content,
		TrimDateTime	sent,
		TrimDateTime	received
	)

Sets the Input Document to be of a TRIM mail message format (a .vmbx file). The supplied parameters should match the original email message fields and will be used in this Input Document object.

void HP.HPTRIM.SDK.InputDocument.SetAsMailMessage ( )

Sets the Input Document to be of a TRIM mail message format (a .vmbx file). The various fields of the original email message should be copied to the corresponding fields on this Input Document object.

void HP.HPTRIM.SDK.InputDocument.SetAsOfflineRecord	(	OfflineRecord	offlineRecordToSetAs,
		bool	UpdateAfterCheckIn
	)

Sets the InputDocument from an Offline Record

void HP.HPTRIM.SDK.InputDocument.SetAuthor	(	string	mailAddress,
		string	displayName,
		string	mailType
	)

Sets the person described by the nominated email address and display name as the Author of the mail message, if this InputDocument is a mail message.

void HP.HPTRIM.SDK.InputDocument.SetAuthor ( EmailParticipant newAuthor )

Sets the person described by the nominated EmailParticipant as the Author of the mail message, if this InputDocument is a mail message.

Property Documentation

string HP.HPTRIM.SDK.InputDocument.AlreadyInStoreExtension

get

Gets a String value indicating the extension of an "already stored" item. Only relevant if IsAlreadyInStore is true.

string HP.HPTRIM.SDK.InputDocument.AlreadyInStoreID

get

Gets a String value indicating the store ID that this input document is already stored as. Only relevant if IsAlreadyInStore is true.

long HP.HPTRIM.SDK.InputDocument.AlreadyInStoreSize

get

Gets an Int64 value indicating the size (in bytes) of an "already stored" item. Only relevant if IsAlreadyInStore is true.

TrimURI HP.HPTRIM.SDK.InputDocument.AlreadyInStoreUri

get

Gets a Int64 value indicating the URI of the store that this input document is already stored in. Only relevant if IsAlreadyInStore is true.

string HP.HPTRIM.SDK.InputDocument.CheckinAs

getset

Gets or sets a string containing the checkin path as it is to be remembered in Content Manager

string HP.HPTRIM.SDK.InputDocument.Content

getset

Gets or sets a string containing the body (main content) of the mail message, if this InputDocument is a mail message

string HP.HPTRIM.SDK.InputDocument.ConversationId

getset

Gets or sets a string containing the conversation id of the mail message, if this InputDocument is a mail message.

string HP.HPTRIM.SDK.InputDocument.ExternalExtension

get

No longer used.

string HP.HPTRIM.SDK.InputDocument.ExternalStoreId

get

No longer used.

bool HP.HPTRIM.SDK.InputDocument.HasAttachments

getset

Gets or sets a boolean value indicating whether the email message has attachments. If you are passing a native email file such as .msg or .eml, this allows you to indicate the email has attachments without having to extract them and pass them into AddAttachment

bool HP.HPTRIM.SDK.InputDocument.IsAlreadyInStore

get

Gets a boolean value indicating whether this inputDocument represents an item that has already stored in a TRIM document store. Note that this does not allow multiple references to a single item - TRIM does not support single instancing in this way.

bool HP.HPTRIM.SDK.InputDocument.IsExternalStoreItem

get

bool HP.HPTRIM.SDK.InputDocument.IsMailMessage

get

Gets a Boolean value indicating whether this InputDocument is a mail message

bool HP.HPTRIM.SDK.InputDocument.IsOfflineRecord

get

Gets a boolean value indicating whether this document is an Offline Record.

string HP.HPTRIM.SDK.InputDocument.LocalFile

get

Gets a string containing the path to the document corresponding to this Input Document. If this InputDocument is a mail message, this is the path to the .vmbx file created through this InputDocument object.

string HP.HPTRIM.SDK.InputDocument.MessageId

getset

Gets or sets a string containing the unique message id of the mail message, if this InputDocument is a mail message.

string HP.HPTRIM.SDK.InputDocument.Name

get

Gets a string containing a descriptive title for this InputDocument object.

string HP.HPTRIM.SDK.InputDocument.NativeMailFile

getset

Gets or sets a string containing the file path to the native mail file for this mail message, if this InputDocument is a mail message.

OfflineRecord HP.HPTRIM.SDK.InputDocument.OfflineRecord

get

Gets the Offline Record object associated with this document.

TrimDateTime HP.HPTRIM.SDK.InputDocument.ReceivedDate

getset

Gets or sets the date this mail message was received, if this InputDocument is a mail message

TrimDateTime HP.HPTRIM.SDK.InputDocument.SentDate

getset

Gets or sets the date the mail message was sent, if this InputDocument is a mail message

string HP.HPTRIM.SDK.InputDocument.Subject

getset

Gets or sets a string containing the subject of the mail message, if this InputDocument is a mail message.

bool HP.HPTRIM.SDK.InputDocument.TimesAreUniversal

getset

Gets or sets a Boolean value indicating whether the times of the 'SentDate' and 'ReceivedDate' properties of this InputDocument are based on Universal Time Coordinates / Greenwich Mean Time.

bool HP.HPTRIM.SDK.InputDocument.UpdateOfflineRecord

get

Gets a Boolean value indicating whether the offline record should be updated or removed as part of the check in process

string HP.HPTRIM.SDK.InputDocument.VerificationHash

getset

Gets or sets a 64-byte MD5 hash of the document that can be used for end to end verification. When the document is submitted to the record this hash will be checked for validity, allowing an end-to-end verification mechanism to be established. For compatibility, you can calculated this hash using the Database.CalculateDocumentHash function.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation