HPE Content Manager SDK 8.3
|
A helper class that encapsulates a document that is to be attached to a TRIM object. More...
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 | 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 HP TRIM. 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... | |
Properties inherited from HP.HPTRIM.SDK.TrimSDKObject | |
string | ErrorMessage [get] |
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... | |
A helper class that encapsulates a document that is to be attached to a TRIM object.
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.
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.
|
get |
Gets a String value indicating the extension of an "already stored" item. Only relevant if IsAlreadyInStore is true.
|
get |
Gets a String value indicating the store ID that this input document is already stored as. Only relevant if IsAlreadyInStore is true.
|
get |
Gets an Int64 value indicating the size (in bytes) of an "already stored" item. Only relevant if IsAlreadyInStore is true.
|
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.
|
getset |
Gets or sets a string containing the checkin path as it is to be remembered in HP TRIM.
|
getset |
Gets or sets a string containing the body (main content) of the mail message, if this InputDocument is a mail message
|
getset |
Gets or sets a string containing the conversation id of the mail message, if this InputDocument is a mail message.
|
get |
No longer used.
|
get |
No longer used.
|
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.
|
get |
|
get |
Gets a Boolean value indicating whether this InputDocument is a mail message
|
get |
Gets a boolean value indicating whether this document is an Offline Record.
|
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.
|
getset |
Gets or sets a string containing the unique message id of the mail message, if this InputDocument is a mail message.
|
get |
Gets a string containing a descriptive title for this InputDocument object.
|
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.
|
get |
Gets the Offline Record object associated with this document.
|
getset |
Gets or sets the date this mail message was received, if this InputDocument is a mail message
|
getset |
Gets or sets the date the mail message was sent, if this InputDocument is a mail message
|
getset |
Gets or sets a string containing the subject of the mail message, if this InputDocument is a mail message.
|
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.
|
get |
Gets a Boolean value indicating whether the offline record should be updated or removed as part of the check in process