Constructors
NSDocumentAgent()
Methods
CheckinDocument(Integer,String[],String,String[])
Checks in a currently checked-out documentCheckoutDocument(Integer,String[])
Checks out a document for editing by the current user.CreateDefaultDocumentEntity()
Sets default values into a new NSDocumentEntity.NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
CreateDefaultDocumentEntityFromSuggestion(Integer)
CreateDefaultDocumentPreview()
Sets default values into a new NSDocumentPreview.NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
CreateDefaultSuggestedDocumentEntity()
Sets default values into a new NSSuggestedDocumentEntity.NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
CreateDefaultTemplateVariablesParameters()
Sets default values into a new NSTemplateVariablesParameters.NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
CreateDocumentStream(NSDocumentEntity,Bool)
Creates a new NSStream that can be used to store the document in the file archive.CreateNewPhysicalDocumentFromTemplate(Integer,Integer,Integer,Integer,Integer,Integer,Integer,String)
Creates a new document content based on a document template and store it in the document archive. Tags are substituted according to the provided IDs.Use GetDocumentStream to obtain the created document. Since there is a potential for a name conflict (the file name stored by the document entity earlier may prove to be invalid), the (possibly amended) document entity is returned. The client should not assume that any earlier, cached entity information is valid.
CreateNewPhysicalDocumentFromTemplateWithCustomTags(Integer,Integer,Integer,Integer,Integer,Integer,Integer,String[],String[],String)
Creates a new physical document based on a document template and store it in the document archive. Tags are substituted according to the provided IDs.Use GetDocumentStream to obtain the created document content. Since there is a potential for a name conflict (the file name stored by the document entity earlier may prove to be invalid), the (possibly amended) document entity is returned. The client should not assume that any earlier, cached entity information is valid.
CreateNewPhysicalDocumentFromTemplateWithCustomTags2(Integer,Integer,Integer,Integer,Integer,Integer,Integer,String)
Creates a new physical document based on a document template and store it in the document archive. Tags are substituted according to the provided IDs.Use GetDocumentStream to obtain the created document content. Since there is a potential for a name conflict (the file name stored by the document entity earlier may prove to be invalid), the (possibly amended) document entity is returned. The client should not assume that any earlier, cached entity information is valid.
CreateNewPhysicalMailMergeDocumentFromTemplate(Integer,String)
Creates a new physical document based on the documents template.Do not replace template tags, as the document is going to be used as a mail merge source.Use GetDocumentStream to obtain the created documents. Since there is a potential for a name conflict (the file name stored by the document entity earlier may prove to be invalid), the (possibly amended) document entity is returned. The client should not assume that any earlier, cached entity information is valid.
CreateTempFile(String)
Creates a new temporary file based on the provided stream. Specified filename may be overridden, and actual name is returned.DeleteDocumentEntity(Integer)
Deletes the NSDocumentEntityDeletePhysicalDocument(Integer,String[])
Deletes the document contentsDeleteTempFile(String)
Deletes a temporary file created with CreateTempFile.ExecuteDocumentCommand(Integer,String,String[],String,String[])
Executes a custom command on a particular document, optionally a particular versionGetAppointmentDocuments(Integer)
Gets all documents that are linked to the appointment (the documents that are listed in the appointment dialog).GetCheckoutState(Integer)
Gets the current checkout state for a document, relative to the user performing the call.GetContactDocuments(Integer,Integer)
Returns a specified number of document appointments within a time range.GetContactDocumentsByTemplateHeading(Integer,Integer,Integer)
Returns a specified number of document appointments within a time range, filtered by the document template heading.GetContactDocumentsByTemplateType(Integer,Integer,Integer)
Returns a specified number of document appointments within a time range, filtered by document template type.GetContactDocumentsByTemplateTypes(Integer,Integer,Integer[])
Returns a specified number of document appointments within a time range, filtered by document template types.GetDocument(Integer)
Gets an NSDocument object.GetDocumentCommands(Integer,String[])
Gets a list of custom commands valid for the specific document at this time.This information should not be cached by clients, as it may change between documents and over time.
GetDocumentEntity(Integer)
Gets an NSDocumentEntity object.GetDocumentList(Integer[])
Gets an array of NSDocument objects.GetDocumentProperties(Integer,String[])
Gets plugin-dependent properties for the document.A number of standard properties that should be supported by all plugins are defined in SuperOffice.CRM.Documents.Constants.Properties.
GetDocumentsByTemplateHeading(Integer)
Returns document appointments, filtered by the document template heading.GetDocumentStream(Integer)
Gets the document content as a streamGetDocumentStreamFromEntity(NSDocumentEntity)
Gets the document as a streamGetDocumentUrl(Integer,String,Bool)
Gets a URL referring to the given document content.This URL may be passed to the ultimate client (text editor of some kind?), which is then responsible for all further operations.Not all documents and document plugins support this feature.
GetMyPublishedDocuments()
GetPersonDocuments(Integer)
Gets all documents that are linked to the person (the documents that are listed in the person dialog).GetPersonDocumentsByDate(Integer,Bool,Integer)
Returns a specified number of document appointments within a time range. The document appointments belong to the person specified.GetPersonDocumentsByTemplateHeading(Integer,Bool,Integer,Integer)
Returns a specified number of document appointments within a time range, filtered by document template heading.GetPersonDocumentsByTemplateType(Integer,Bool,Integer,Integer)
Returns a specified number of document appointments within a time range, filtered by document template type.GetPersonDocumentsByTemplateTypes(Integer,Bool,Integer,Integer[])
Returns a specified number of document appointments within a time range, filtered by document template types.GetPluginCapabilities(Integer)
Gets a list of plugin-dependent capabilities for a given document archive plugin.GetPluginList()
Gets a list of installed document pluginsGetPreviewDocumentStream(Integer)
Gets the preview version of the document content as a stream. Retrieves a sanitized version if possibleGetProjectDocuments(Integer,Integer)
Returns a specified number of document appointments within a time range.GetProjectDocumentsByTemplateHeading(Integer,Integer,Integer)
Returns a specified number of document appointments within a time range, filtered by document template heading.GetProjectDocumentsByTemplateType(Integer,Integer,Integer)
Returns a specified number of document appointments within a time range, filtered by document template type.GetProjectDocumentsByTemplateTypes(Integer,Integer,Integer[])
Returns a specified number of document appointments within a time range, filtered by document template types.GetProjectMemberDocuments(Integer,Integer)
Returns a specified number of document appointments within a time range.GetProjectMemberDocumentsByTemplateHeading(Integer,Integer,Integer)
Returns a specified number of document appointments within a time range, filtered by document template heading.GetProjectMemberDocumentsByTemplateType(Integer,Integer,Integer)
Returns a specified number of document appointments within a time range, filtered by document template type.GetProjectMemberDocumentsByTemplateTypes(Integer,Integer,Integer[])
Returns a specified number of document appointments within a time range, filtered by document template types.GetPublishedDocument(Integer)
Gets the document if it’s publishedGetPublishedDocuments(Integer[])
Gets the published documents from an array of document IDs.GetPublishedDocumentsByDate(Integer,Bool,Integer)
Returns a specified number of published document appointments within a time range.GetPublishedPersonDocumentsByDate(Integer,Bool,Integer)
Returns a specified number of published document appointments within a time range.GetPublishedProjectDocuments(Integer)
Gets published appointment documents by project ID.GetSaleDocuments(Integer)
Gets all documents that are linked to the sale (the documents that are listed in the sale dialog).GetSanitizedDocumentStream(Integer)
Gets the document content as a stream. Retrieves a sanitized version if possibleGetSanitizedTemplateStream(String,Bool,String)
Retrieves a stream to a mail template based on its name. Sanitizes the contents if possible.GetSanitizedTemplateStreamFromId(Integer,String)
Retrieve a stream to a document template based on its ID. Sanitizes the contents if possible.GetSuggestedDocumentEntity(Integer)
Gets an NSSuggestedDocumentEntity object.GetTempFile(String)
Gets data stream for temporary file created with CreateTempFile.GetTemplateStream(String,Bool,String)
Retrieve a stream to a mail template based on its nameGetTemplateStreamFromId(Integer,String)
Retrieve a stream to a document template based on its IDGetUnsanitizedPreviewDocumentStream(Integer)
Gets the preview version of the document content as a stream. Retrieves an unsanitized version.This has less CPU impact but the caller must sanitize the content before presenting it to the user.
GetVersionList(Integer)
Gets a list of existing, committed versions for a given documentRenameDocument(Integer,String)
Rename the physical document (change the file name or equivalent concept in the document archive).SaveDocumentEntity(NSDocumentEntity)
Updates the existing NSDocumentEntity or creates a new NSDocumentEntity if the id parameter is 0SaveDocumentTemplateStream(Integer,NSStream,String,Integer)
Saves content in stream to document template fileSavePrivacyReport(String,String,Integer)
Generates a PDF from HTML and makes a documentSaveSuggestedDocumentEntity(NSSuggestedDocumentEntity)
Updates the existing NSSuggestedDocumentEntity or creates a new NSSuggestedDocumentEntity if the id parameter is 0SetDocumentStream(NSDocumentEntity,Bool)
Store a document’s contents from its stream. Since there is a potential for a name conflict (the file name stored by the document entity earlier may prove to be invalid), the (possibly amended) document entity is returned.The client should not assume that any earlier, cached entity information is valid.
SetDocumentStreamFromId(Integer)
Stores document content from stream. Since there is a potential for a name conflict (the file name stored by the document entity earlier may prove to be invalid), the (possibly amended) document entity is returned.The client should not assume that any earlier, cached entity information is valid.