Interface IFileApi
Contains methods to operate with the filesystem on the server.
public interface IFileApiMethods
- AssignRefIdToFile(FileId, string)
Assigns a subscriber defined id to a file.
- CancelSubmission(FileId, string)
Cancel an opened submission.
- CompleteSubmission(FileId, string)
Complete an opened submission.
- CreateNewFile(string)
Creates a new file.
- DeleteDocumentFromFile(FileId, DocumentId, string)
Deletes a document from a file.
- DeleteFile(FileId)
Deletes an existing file.
- DiscardFinishedSubmission(FileId)
Removes a file from the list of submissions.
- GetFileByRefId(string)
Gets the id for the file that has the given ref-id.
- GrantAccessToFile(FileId, Addressee, Timestamp, string, GrantOptions)
Grant access to a file.
- HoldSubmission(FileId, string)
Hold an opened submission.
- ListAllSubmissions()
Lists all submissions.
- ListCompletedSubmissions()
Lists all completed submissions.
- ListDocuments(FileId)
Lists the documents contained in the file.
- ListNewSubmissions()
Lists all new submissions.
- ListRejectedSubmissions()
Lists all rejected submissions.
- MergeFiles(FileId, FileId)
All of this file's content will be merged into the destination file.
- MoveDocumentToFile(FileId, FileId, DocumentId)
Moves a document from one file to another.
- OpenSubmission(FileId, Addressee, Timestamp, string, SubmissionOptions)
Submit a file to a destination party for processing.
- RejectSubmission(FileId, string)
Reject an opened submission.
- RestoreDeletedDocumentToFile(FileId, DocumentId)
Restores a deleted document to a file.
- RevokeAccessFromFile(FileId, Addressee, string)
Revoke previously granted access to a file.
- SetFileMainDocument(FileId, DocumentId)
Sets a document as the files main document.
- SetLocalSubmission(FileId, string, string)
Sets the account that has the local submission for a file.