Interface IDocumentApi
Contains different methods to access documents on the server.
public interface IDocumentApiMethods
- ApplyInboxFilter(bool?)
Executes the inbox filter rules.
- ChangeDocumentPrivacyLevel(DocumentId, PrivacyLevel)
Changes the documents privacy level.
- DeliverDocument(DocumentId, FileId, Addressee, bool, string)
Distribute the document to another party. Avoids copies where possible.
- ExportCurrentDocument(DocumentId, LogId)
Downloads a document from the service by its docId.
- FindFilesToDocument(DocumentId)
Finds the files that contain documents with related identifiers as the given document.
- GetDocumentByIdent(DocumentIdentifierType, string)
Find a document identifier by other identifiers, e.g. from the document's content.
- GetDocumentParameter(DocumentId, string, bool)
Gets the value of a subscriber defined key on document.
- GetDocumentParticipant(DocumentId, LogId, ParticipantType)
Get address and id information about the last editing party of the document - as far as available.
- GetNextDocument()
Gets the next document from the Inbox.
- GetTransferDetails(DocumentId, LogId)
Queries the status of a transfer request previously initiated via SendDocument(DocumentId, LogId, Addressee, string, TransportMethod).
- GetTransportDocumentByIdent(DocumentIdentifierType, string)
Find a document identifier by other identifiers, e.g. from the document's content. Limited to transport documents.
- ImportDocumentToFile(byte[], PrivacyLevel, FileId)
Add to or create a new file area document in a specific file. Will choose a fitting document if possible or create a new one otherwise.
- ImportDocumentToFileArea(byte[], PrivacyLevel)
Add to or create a new file area document. Will choose a fitting document and file if possible or create a new one otherwise.
- ImportDocumentToFileAreaFromInbox(DocumentId, PrivacyLevel)
Add to or create a new file area document from an existing inbox document. Will choose a fitting document and file if possible or create a new one otherwise.
- ImportDocumentToFileFromInbox(DocumentId, FileId, PrivacyLevel)
Add to or create a new file area document in a specific file from an existing inbox document. Will choose a fitting document if possible or create a new one otherwise.
- ImportNewDocumentToFileFromInbox(DocumentId, FileId, PrivacyLevel)
Create a new file area document in a specific file from an existing inbox document.
- ImportToDocument(byte[], DocumentId)
Add a version to a specific existing document. Works for documents in every writable area.
- ImportToDocumentInFileFromInbox(DocumentId, DocumentId)
Add to a specific existing file area document from an existing inbox document.
- ImportTransportDocument(byte[], bool, bool, bool, TemplateUsage)
Uploads a transport document to the service. The service recognizes whether it is an update of a document or a new creation of a document.
- ImportTransportDocumentFromInbox(DocumentId, bool, bool)
Uploads a transport document to the service from the inbox The transport document has to be in the zedal inbox.
- ListDocumentsByParameters(IEnumerable<Parameter>)
Lists all documents with a specific key value pair.
- ListInbox(DateTime, DateTime, bool?)
Lists transport documents by their docId from the inbox filtered using a date interval from, to Can optionally be filtered whether only read or unread should be taken into account.
- PeekNextFileAreaDocument()
List the next file area document delivered by the distribution module. See 'SetFileAreaDocumentReceived'.
- PeekNextTransportDocument()
List the next transport document delivered by the distribution module. See 'SetTransportDocumentReceived'.
- RemoveDocumentsFromInbox(IEnumerable<DocumentId>)
Deletes the documents with the given id from the inbox.
- SendDocument(DocumentId, LogId, Addressee, string, TransportMethod)
Explicitly send a copy of the document to another party's inbox.
- SetDocumentParameter(DocumentId, string, string, bool)
Assigns a subscriber defined key value pair to a document.
- SetFileAreaDocumentReceived(DocumentId, LogId)
Confirms that the delivery of a file area document has been received. See 'PeekNextFileAreaDocument'.
- SetInboxDocumentsRead(IEnumerable<DocumentId>)
Sets the specified documents in the inbox to read.
- SetTransportDocumentReceived(DocumentId, LogId)
Confirms that the delivery of a transport document has been received. See 'PeekNextTransportDocument'.