 |
dotmailer SDK
Tools to access and manage an account in the dotMailer system
|
dotMailer.Sdk.DocumentFactory Class Reference
Provides access to the document factory More...
Inheritance diagram for dotMailer.Sdk.DocumentFactory:
Public Member Functions | |
| DmDocumentFolder | CreateDocumentFolder (string name, int parentFolderId) |
| Creates a new document folder with the specified name, beneath the parent folder specified. | |
| DmDocumentFolder | CreateDocumentFolder (string name, DmDocumentFolder parentFolder) |
| Creates a new document folder with the specified name, beneath the parent folder specified. | |
| DmDocumentFolder | CreateRootDocumentFolder (string name) |
| Creates a new document folder in the root with the specified name. | |
| DmDocumentFolder | GetDocumentFolderTree () |
| Returns an up to date representation of the complete tree of document folders. | |
| DmDocumentCollection | ListDocuments (int parentFolderId) |
| Returns a collection of documents that exist within the parent folder with the passed document folder ID. | |
| DmDocumentCollection | ListDocuments (DmDocumentFolder parentFolder) |
| Returns a collection of documents that exist within the parent folder specified. | |
| DmDocument | UploadDocument (int parentFolderId, String dotMailerFilename, Byte[] documentData) |
| Upload a document to the specified folder. | |
| DmDocument | UploadDocument (int parentFolderId, String dotMailerFilename, Stream documentDataStream) |
| Upload a document to the specified folder. | |
| DmDocument | UploadDocument (int parentFolderId, string dotMailerFilename, string filename) |
| Upload a document to the specified folder. | |
| DmDocument | UploadDocument (int parentFolderId, string filename) |
| Upload a document to the specified folder. | |
| DmDocument | UploadDocument (DmDocumentFolder parentFolder, string dotMailerFilename, Byte[] documentData) |
| Upload a document to the specified folder. | |
| DmDocument | UploadDocument (DmDocumentFolder parentFolder, string dotMailerFilename, Stream documentDataStream) |
| Upload a document to the specified folder. | |
| DmDocument | UploadDocument (DmDocumentFolder parentFolder, string dotMailerFilename, string filename) |
| Upload a document to the specified folder. | |
| DmDocument | UploadDocument (DmDocumentFolder parentFolder, string filename) |
| Upload a document to the specified folder. | |
Properties | |
| int | RootFolderId [get] |
| The ID of the root folder in the Document Manager. | |
Detailed Description
Provides access to the document factory
Member Function Documentation
| DmDocumentFolder dotMailer.Sdk.DocumentFactory.CreateDocumentFolder | ( | string | name, |
| int | parentFolderId | ||
| ) |
Creates a new document folder with the specified name, beneath the parent folder specified.
- Parameters
-
name The name of the new folder. parentFolderId The ID of the parent folder under which the new folder will be created, or zero to create a folder within the root folder.
- Returns
- A reference to the newly created folder.
| DmDocumentFolder dotMailer.Sdk.DocumentFactory.CreateDocumentFolder | ( | string | name, |
| DmDocumentFolder | parentFolder | ||
| ) |
Creates a new document folder with the specified name, beneath the parent folder specified.
- Parameters
-
parentFolder The parent folder under which the new folder will be created, or null to create a folder within the root folder. name The name of the new folder.
- Returns
- A reference to the newly created folder.
| DmDocumentFolder dotMailer.Sdk.DocumentFactory.CreateRootDocumentFolder | ( | string | name | ) |
Creates a new document folder in the root with the specified name.
- Parameters
-
name The name of the new folder.
- Returns
- A reference to the newly created folder.
| DmDocumentFolder dotMailer.Sdk.DocumentFactory.GetDocumentFolderTree | ( | ) |
Returns an up to date representation of the complete tree of document folders.
- Returns
| DmDocumentCollection dotMailer.Sdk.DocumentFactory.ListDocuments | ( | int | parentFolderId | ) |
Returns a collection of documents that exist within the parent folder with the passed document folder ID.
- Parameters
-
parentFolderId The ID of the parent folder to return the documents from.
- Returns
- The documents contained in the specified documents folder.
| DmDocumentCollection dotMailer.Sdk.DocumentFactory.ListDocuments | ( | DmDocumentFolder | parentFolder | ) |
Returns a collection of documents that exist within the parent folder specified.
- Parameters
-
parentFolder The parent folder to return the documents from.
- Returns
- The documents contained in the specified documents folder.
| DmDocument dotMailer.Sdk.DocumentFactory.UploadDocument | ( | int | parentFolderId, |
| String | dotMailerFilename, | ||
| Byte[] | documentData | ||
| ) |
Upload a document to the specified folder.
- Parameters
-
parentFolderId The ID of the document folder in which the document should appear. dotMailerFilename The filename to display within dotMailer. documentData The document data to upload.
- Returns
- A reference to the uploaded document.
| DmDocument dotMailer.Sdk.DocumentFactory.UploadDocument | ( | int | parentFolderId, |
| String | dotMailerFilename, | ||
| Stream | documentDataStream | ||
| ) |
Upload a document to the specified folder.
- Parameters
-
parentFolderId The ID of the document folder in which the document should appear. dotMailerFilename The filename to display within dotMailer. documentDataStream A stream containing the document data to upload.
- Returns
- A reference to the uploaded document.
| DmDocument dotMailer.Sdk.DocumentFactory.UploadDocument | ( | int | parentFolderId, |
| string | dotMailerFilename, | ||
| string | filename | ||
| ) |
Upload a document to the specified folder.
- Parameters
-
parentFolderId The ID of the Document Manager folder in which the document should appear. dotMailerFilename The filename to display within dotMailer. filename The filename of the document to upload.
- Returns
| DmDocument dotMailer.Sdk.DocumentFactory.UploadDocument | ( | int | parentFolderId, |
| string | filename | ||
| ) |
Upload a document to the specified folder.
- Parameters
-
parentFolderId The ID of the Document Manager folder in which the document should appear. filename The filename of the document to upload.
- Returns
| DmDocument dotMailer.Sdk.DocumentFactory.UploadDocument | ( | DmDocumentFolder | parentFolder, |
| string | dotMailerFilename, | ||
| Byte[] | documentData | ||
| ) |
Upload a document to the specified folder.
- Parameters
-
parentFolder The Document Manager folder in which the document should appear. dotMailerFilename The filename to display within dotMailer. documentData The document data to upload.
- Returns
- A reference to the uploaded document.
| DmDocument dotMailer.Sdk.DocumentFactory.UploadDocument | ( | DmDocumentFolder | parentFolder, |
| string | dotMailerFilename, | ||
| Stream | documentDataStream | ||
| ) |
Upload a document to the specified folder.
- Parameters
-
parentFolder The Document Manager folder in which the document should appear. dotMailerFilename The filename to display within dotMailer. documentDataStream A stream containing the document data to upload.
- Returns
| DmDocument dotMailer.Sdk.DocumentFactory.UploadDocument | ( | DmDocumentFolder | parentFolder, |
| string | dotMailerFilename, | ||
| string | filename | ||
| ) |
Upload a document to the specified folder.
- Parameters
-
parentFolder The Document Manager folder in which the document should appear. dotMailerFilename The filename to display within dotMailer. filename The filename of the document to upload.
- Returns
| DmDocument dotMailer.Sdk.DocumentFactory.UploadDocument | ( | DmDocumentFolder | parentFolder, |
| string | filename | ||
| ) |
Upload a document to the specified folder.
- Parameters
-
parentFolder The Document Manager folder in which the document should appear. filename The filename of the document to upload.
- Returns
Property Documentation
|
get |
The ID of the root folder in the Document Manager.
Generated by
1.8.3