OKMRest  3.4.1
OpenKM Rest
com.openkm.sdk4csharp.definition.BaseDocument Interface Reference
Inheritance diagram for com.openkm.sdk4csharp.definition.BaseDocument:

Public Member Functions

Document createDocument (String uuid, String name, FileStream fileStream)
 
void deleteDocument (String docId)
 
Document getDocumentProperties (String docId)
 
Stream getContent (String docId)
 
Stream getContentByVersion (String docId, String versionId)
 
List< DocumentgetDocumentChildren (String fldId)
 
Document renameDocument (String docId, String newName)
 
void setProperties (String uuid, String title, String description, String lang, List< String > keywords, List< String > categories)
 
void setLanguage (String uuid, String lang)
 
void setDocumentTitle (String docId, String title)
 
void setDocumentNodeClass (String docId, long ncId)
 
void checkout (String docId)
 
void cancelCheckout (String docId)
 
void forceCancelCheckout (String docId)
 
Boolean isCheckedOut (String docId)
 
com.openkm.sdk4csharp.bean.Version checkin (String docId, String comment, Stream fileStream)
 
com.openkm.sdk4csharp.bean.Version checkin (String docId, String comment, Stream fileStream, int increment)
 
LockInfo lockDocument (String docId)
 
void unlockDocument (String docId)
 
void forceUnlockDocument (String docId)
 
Boolean isLocked (String docId)
 
LockInfo getLockInfo (String docId)
 
void purgeDocument (String docId)
 
void moveDocument (String docId, String dstId)
 
Document copyDocument (String docId, String dstId, String newName)
 
long getVersionHistorySize (String docId)
 
Boolean isValidDocument (String docId)
 
String getDocumentPath (String uuid)
 
List< String > getDetectedLanguages ()
 
void extendedDocumentCopy (String docId, String dstId, String name, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki)
 
String getExtractedText (String docId)
 
Stream getThumbnail (String docId, String type)
 
Document createFromTemplate (String docId, String dstPath, String language, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki, Dictionary< String, String > properties)
 
void updateFromTemplate (String docId, String dstId, Dictionary< String, String > properties)
 
String getAnnotations (String docId, String verName)
 
Stream getDifferences (String docId, String v1, String v2)
 
List< DocumentgetCheckedOut ()
 
void setDocumentDescription (String uuid, String description)
 
void setDocumentDispositionStage (String uuid, long stage)
 
WizardNode createWizardDocument (String uuid, String name, long nodeClass, FileStream fs)
 
bool isOCRDataCaptureSupported (String uuid)
 
OCRRecognise recognize (String uuid)
 
void captureData (String uuid, long templateId)
 
String generateDownloadToken (String uuid)
 
int getNumberOfPages (String uuid)
 
String getPageAsImage (String uuid, int pageNumber, int maxWidth, int maxHeight)
 
void mergePdf (String destinationUuid, String docName, List< String > uuids)
 

Member Function Documentation

void com.openkm.sdk4csharp.definition.BaseDocument.cancelCheckout ( String  docId)
void com.openkm.sdk4csharp.definition.BaseDocument.captureData ( String  uuid,
long  templateId 
)
com.openkm.sdk4csharp.bean.Version com.openkm.sdk4csharp.definition.BaseDocument.checkin ( String  docId,
String  comment,
Stream  fileStream 
)
com.openkm.sdk4csharp.bean.Version com.openkm.sdk4csharp.definition.BaseDocument.checkin ( String  docId,
String  comment,
Stream  fileStream,
int  increment 
)
void com.openkm.sdk4csharp.definition.BaseDocument.checkout ( String  docId)
Document com.openkm.sdk4csharp.definition.BaseDocument.copyDocument ( String  docId,
String  dstId,
String  newName 
)
Document com.openkm.sdk4csharp.definition.BaseDocument.createDocument ( String  uuid,
String  name,
FileStream  fileStream 
)
Document com.openkm.sdk4csharp.definition.BaseDocument.createFromTemplate ( String  docId,
String  dstPath,
String  language,
Boolean  categories,
Boolean  keywords,
Boolean  propertyGroups,
Boolean  notes,
Boolean  wiki,
Dictionary< String, String >  properties 
)
WizardNode com.openkm.sdk4csharp.definition.BaseDocument.createWizardDocument ( String  uuid,
String  name,
long  nodeClass,
FileStream  fs 
)
void com.openkm.sdk4csharp.definition.BaseDocument.deleteDocument ( String  docId)
void com.openkm.sdk4csharp.definition.BaseDocument.extendedDocumentCopy ( String  docId,
String  dstId,
String  name,
Boolean  categories,
Boolean  keywords,
Boolean  propertyGroups,
Boolean  notes,
Boolean  wiki 
)
void com.openkm.sdk4csharp.definition.BaseDocument.forceCancelCheckout ( String  docId)
void com.openkm.sdk4csharp.definition.BaseDocument.forceUnlockDocument ( String  docId)
String com.openkm.sdk4csharp.definition.BaseDocument.generateDownloadToken ( String  uuid)
String com.openkm.sdk4csharp.definition.BaseDocument.getAnnotations ( String  docId,
String  verName 
)
List<Document> com.openkm.sdk4csharp.definition.BaseDocument.getCheckedOut ( )
Stream com.openkm.sdk4csharp.definition.BaseDocument.getContent ( String  docId)
Stream com.openkm.sdk4csharp.definition.BaseDocument.getContentByVersion ( String  docId,
String  versionId 
)
List<String> com.openkm.sdk4csharp.definition.BaseDocument.getDetectedLanguages ( )
Stream com.openkm.sdk4csharp.definition.BaseDocument.getDifferences ( String  docId,
String  v1,
String  v2 
)
List<Document> com.openkm.sdk4csharp.definition.BaseDocument.getDocumentChildren ( String  fldId)
String com.openkm.sdk4csharp.definition.BaseDocument.getDocumentPath ( String  uuid)
Document com.openkm.sdk4csharp.definition.BaseDocument.getDocumentProperties ( String  docId)
String com.openkm.sdk4csharp.definition.BaseDocument.getExtractedText ( String  docId)
LockInfo com.openkm.sdk4csharp.definition.BaseDocument.getLockInfo ( String  docId)
int com.openkm.sdk4csharp.definition.BaseDocument.getNumberOfPages ( String  uuid)
String com.openkm.sdk4csharp.definition.BaseDocument.getPageAsImage ( String  uuid,
int  pageNumber,
int  maxWidth,
int  maxHeight 
)
Stream com.openkm.sdk4csharp.definition.BaseDocument.getThumbnail ( String  docId,
String  type 
)
long com.openkm.sdk4csharp.definition.BaseDocument.getVersionHistorySize ( String  docId)
Boolean com.openkm.sdk4csharp.definition.BaseDocument.isCheckedOut ( String  docId)
Boolean com.openkm.sdk4csharp.definition.BaseDocument.isLocked ( String  docId)
bool com.openkm.sdk4csharp.definition.BaseDocument.isOCRDataCaptureSupported ( String  uuid)
Boolean com.openkm.sdk4csharp.definition.BaseDocument.isValidDocument ( String  docId)
LockInfo com.openkm.sdk4csharp.definition.BaseDocument.lockDocument ( String  docId)
void com.openkm.sdk4csharp.definition.BaseDocument.mergePdf ( String  destinationUuid,
String  docName,
List< String >  uuids 
)
void com.openkm.sdk4csharp.definition.BaseDocument.moveDocument ( String  docId,
String  dstId 
)
void com.openkm.sdk4csharp.definition.BaseDocument.purgeDocument ( String  docId)
OCRRecognise com.openkm.sdk4csharp.definition.BaseDocument.recognize ( String  uuid)
Document com.openkm.sdk4csharp.definition.BaseDocument.renameDocument ( String  docId,
String  newName 
)
void com.openkm.sdk4csharp.definition.BaseDocument.setDocumentDescription ( String  uuid,
String  description 
)
void com.openkm.sdk4csharp.definition.BaseDocument.setDocumentDispositionStage ( String  uuid,
long  stage 
)
void com.openkm.sdk4csharp.definition.BaseDocument.setDocumentNodeClass ( String  docId,
long  ncId 
)
void com.openkm.sdk4csharp.definition.BaseDocument.setDocumentTitle ( String  docId,
String  title 
)
void com.openkm.sdk4csharp.definition.BaseDocument.setLanguage ( String  uuid,
String  lang 
)
void com.openkm.sdk4csharp.definition.BaseDocument.setProperties ( String  uuid,
String  title,
String  description,
String  lang,
List< String >  keywords,
List< String >  categories 
)
void com.openkm.sdk4csharp.definition.BaseDocument.unlockDocument ( String  docId)
void com.openkm.sdk4csharp.definition.BaseDocument.updateFromTemplate ( String  docId,
String  dstId,
Dictionary< String, String >  properties 
)

The documentation for this interface was generated from the following file: