OKMRest
3.9.0
OpenKM Rest
|
Public Member Functions | |
DocumentImpl (String host) | |
void | setAuthorizationToken (String authorizationToken) |
Document | createDocument (String uuid, FileInfo fileInfo) |
createDocument More... | |
Document | createDocument (String uuid, String name, FileStream fileStream) |
createSimple More... | |
void | deleteDocument (String docId) |
delete More... | |
Document | getDocumentProperties (String docId) |
getProperties More... | |
Stream | getContent (String docId) |
getContent More... | |
Stream | getContentByVersion (String docId, String versionId) |
getContentByVersion More... | |
String | getExtractedText (String docId) |
getExtractedText More... | |
Stream | getThumbnail (String docId, String type) |
getThumbnail More... | |
List< Document > | getDocumentChildren (String fldId) |
getChildren More... | |
Document | renameDocument (String docId, String newName) |
rename More... | |
void | setProperties (String uuid, String title, String description, String lang, List< String > keywords, List< String > categories) |
setProperties More... | |
void | setLanguage (String uuid, String lang) |
setLanguage More... | |
void | setDocumentTitle (String docId, String title) |
setTitle More... | |
void | setDocumentNodeClass (String docId, long ncId) |
setDocumentNodeClass More... | |
void | checkout (String docId) |
checkout More... | |
void | cancelCheckout (String docId) |
cancelCheckout More... | |
void | forceCancelCheckout (String docId) |
forceCancelCheckout More... | |
Boolean | isCheckedOut (String docId) |
isCheckedOut More... | |
com.openkm.sdk4csharp.bean.Version | checkin (String docId, String comment, Stream fileStream) |
checkin More... | |
com.openkm.sdk4csharp.bean.Version | checkin (String docId, String comment, Stream fileStream, int increment) |
checkin More... | |
LockInfo | lockDocument (String docId) |
lockDocument More... | |
void | unlockDocument (String docId) |
unlockDocument More... | |
void | forceUnlockDocument (String docId) |
forceUnlockDocument More... | |
Boolean | isLocked (String docId) |
isLocked More... | |
LockInfo | getLockInfo (String docId) |
getLockInfo More... | |
void | purgeDocument (String docId) |
purge More... | |
void | moveDocument (String docId, String dstId) |
moveDocument More... | |
Document | copyDocument (String docId, String dstId, String newName) |
copyDocument More... | |
long | getVersionHistorySize (String docId) |
getVersionHistorySize More... | |
Boolean | isValidDocument (String docId) |
isValid More... | |
String | getDocumentPath (String uuid) |
getPath More... | |
List< String > | getDetectedLanguages () |
getDetectedLanguages More... | |
void | extendedDocumentCopy (String docId, String dstId, String name, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki) |
extendedCopy More... | |
Document | createDocumentFromTemplate (String docId, String dstPath, String language, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki, Dictionary< String, String > properties) |
createDocumentFromTemplate More... | |
void | updateDocumentFromTemplate (String docId, String dstId, Dictionary< String, String > properties) |
updateDocumentFromTemplate More... | |
String | getAnnotations (String docId, String verName) |
getAnnotations More... | |
Stream | getDifferences (String docId, String v1, String v2) |
getDifferences More... | |
List< Document > | getCheckedOut () |
getCheckedOut More... | |
void | setDocumentDescription (String uuid, String description) |
setDocumentDescription More... | |
void | setDocumentDispositionStage (String uuid, long stage) |
setDocumentDispositionStage More... | |
WizardNode | createWizardDocument (String uuid, String name, long nodeClass, FileStream fs) |
createWizardDocument More... | |
bool | isOCRDataCaptureSupported (String uuid) |
isOCRDataCaptureSupported More... | |
OCRRecognise | recognize (String uuid) |
recognize More... | |
void | captureData (String uuid, long templateId) |
captureData More... | |
int | getNumberOfPages (String uuid) |
getNumberOfPages More... | |
String | getPageAsImage (String uuid, int pageNumber, int maxWidth, int maxHeight) |
getPageAsImage More... | |
void | mergePdf (String destinationUuid, String docName, List< String > uuids) |
mergePdf More... | |
List< String > | getLiveEditRestrictedMimeTypes () |
getLiveEditRestrictedMimeTypes More... | |
void | liveEditCheckin (String uuid, String comment, int increment) |
liveEditCheckin More... | |
void | liveEditSetContent (String uuid, FileStream fileStream) |
liveEditSetContent More... | |
bool | isAttachment (String uuid) |
isAttachment More... | |
bool | isConvertibleToPDF (String uuid) |
isConvertibleToPDF More... | |
Public Member Functions inherited from com.openkm.sdk4csharp.impl.ClientImpl | |
RestClient | getClient (String url) |
getClient More... | |
RestClient | getClient (String url, String user, String password) |
getClient More... | |
com.openkm.sdk4csharp.impl.DocumentImpl.DocumentImpl | ( | String | host | ) |
void com.openkm.sdk4csharp.impl.DocumentImpl.cancelCheckout | ( | String | docId | ) |
cancelCheckout
docId |
void com.openkm.sdk4csharp.impl.DocumentImpl.captureData | ( | String | uuid, |
long | templateId | ||
) |
captureData
uuid | |
templateId |
com.openkm.sdk4csharp.bean.Version com.openkm.sdk4csharp.impl.DocumentImpl.checkin | ( | String | docId, |
String | comment, | ||
Stream | fileStream | ||
) |
checkin
docId | |
comment | |
srcPath |
com.openkm.sdk4csharp.bean.Version com.openkm.sdk4csharp.impl.DocumentImpl.checkin | ( | String | docId, |
String | comment, | ||
Stream | fileStream, | ||
int | increment | ||
) |
checkin
docId | |
comment | |
fileStream | |
increment |
void com.openkm.sdk4csharp.impl.DocumentImpl.checkout | ( | String | docId | ) |
checkout
docId |
Document com.openkm.sdk4csharp.impl.DocumentImpl.copyDocument | ( | String | docId, |
String | dstId, | ||
String | newName | ||
) |
copyDocument
docId | |
dstId |
Document com.openkm.sdk4csharp.impl.DocumentImpl.createDocument | ( | String | uuid, |
FileInfo | fileInfo | ||
) |
createDocument
uuid | |
fileInfo |
Document com.openkm.sdk4csharp.impl.DocumentImpl.createDocument | ( | String | uuid, |
String | name, | ||
FileStream | fileStream | ||
) |
createSimple
uuid | |
name |
Document com.openkm.sdk4csharp.impl.DocumentImpl.createDocumentFromTemplate | ( | String | docId, |
String | dstPath, | ||
String | language, | ||
Boolean | categories, | ||
Boolean | keywords, | ||
Boolean | propertyGroups, | ||
Boolean | notes, | ||
Boolean | wiki, | ||
Dictionary< String, String > | properties | ||
) |
createDocumentFromTemplate
docId | |
dstPath | |
languege |
WizardNode com.openkm.sdk4csharp.impl.DocumentImpl.createWizardDocument | ( | String | uuid, |
String | name, | ||
long | nodeClass, | ||
FileStream | fs | ||
) |
createWizardDocument
uuid | |
name | |
nodeClass | |
fs |
void com.openkm.sdk4csharp.impl.DocumentImpl.deleteDocument | ( | String | docId | ) |
delete
docId |
void com.openkm.sdk4csharp.impl.DocumentImpl.extendedDocumentCopy | ( | String | docId, |
String | dstId, | ||
String | name, | ||
Boolean | categories, | ||
Boolean | keywords, | ||
Boolean | propertyGroups, | ||
Boolean | notes, | ||
Boolean | wiki | ||
) |
extendedCopy
docId | |
dstId | |
name | |
categories | |
keywords | |
propertyGroups | |
notes | |
wiki |
void com.openkm.sdk4csharp.impl.DocumentImpl.forceCancelCheckout | ( | String | docId | ) |
forceCancelCheckout
docId |
void com.openkm.sdk4csharp.impl.DocumentImpl.forceUnlockDocument | ( | String | docId | ) |
forceUnlockDocument
docId |
String com.openkm.sdk4csharp.impl.DocumentImpl.getAnnotations | ( | String | docId, |
String | verName | ||
) |
getAnnotations
docId | |
verName |
List<Document> com.openkm.sdk4csharp.impl.DocumentImpl.getCheckedOut | ( | ) |
getCheckedOut
fldId |
Stream com.openkm.sdk4csharp.impl.DocumentImpl.getContent | ( | String | docId | ) |
getContent
docId |
Stream com.openkm.sdk4csharp.impl.DocumentImpl.getContentByVersion | ( | String | docId, |
String | versionId | ||
) |
getContentByVersion
docId | |
versionId |
List<String> com.openkm.sdk4csharp.impl.DocumentImpl.getDetectedLanguages | ( | ) |
getDetectedLanguages
docId |
Stream com.openkm.sdk4csharp.impl.DocumentImpl.getDifferences | ( | String | docId, |
String | v1, | ||
String | v2 | ||
) |
getDifferences
docId | |
v1 | |
v2 |
List<Document> com.openkm.sdk4csharp.impl.DocumentImpl.getDocumentChildren | ( | String | fldId | ) |
getChildren
fldId |
String com.openkm.sdk4csharp.impl.DocumentImpl.getDocumentPath | ( | String | uuid | ) |
getPath
docId |
Document com.openkm.sdk4csharp.impl.DocumentImpl.getDocumentProperties | ( | String | docId | ) |
getProperties
docId |
String com.openkm.sdk4csharp.impl.DocumentImpl.getExtractedText | ( | String | docId | ) |
getExtractedText
docId |
List<String> com.openkm.sdk4csharp.impl.DocumentImpl.getLiveEditRestrictedMimeTypes | ( | ) |
getLiveEditRestrictedMimeTypes
LockInfo com.openkm.sdk4csharp.impl.DocumentImpl.getLockInfo | ( | String | docId | ) |
getLockInfo
docId |
int com.openkm.sdk4csharp.impl.DocumentImpl.getNumberOfPages | ( | String | uuid | ) |
getNumberOfPages
uuid |
String com.openkm.sdk4csharp.impl.DocumentImpl.getPageAsImage | ( | String | uuid, |
int | pageNumber, | ||
int | maxWidth, | ||
int | maxHeight | ||
) |
getPageAsImage
uuid | |
pageNumber | |
maxWidth | |
maxHeight |
Stream com.openkm.sdk4csharp.impl.DocumentImpl.getThumbnail | ( | String | docId, |
String | type | ||
) |
getThumbnail
docId | DocId |
long com.openkm.sdk4csharp.impl.DocumentImpl.getVersionHistorySize | ( | String | docId | ) |
getVersionHistorySize
docId |
bool com.openkm.sdk4csharp.impl.DocumentImpl.isAttachment | ( | String | uuid | ) |
isAttachment
uuid |
Boolean com.openkm.sdk4csharp.impl.DocumentImpl.isCheckedOut | ( | String | docId | ) |
isCheckedOut
docId |
bool com.openkm.sdk4csharp.impl.DocumentImpl.isConvertibleToPDF | ( | String | uuid | ) |
isConvertibleToPDF
uuid |
Boolean com.openkm.sdk4csharp.impl.DocumentImpl.isLocked | ( | String | docId | ) |
isLocked
docId |
bool com.openkm.sdk4csharp.impl.DocumentImpl.isOCRDataCaptureSupported | ( | String | uuid | ) |
isOCRDataCaptureSupported
uuid |
Boolean com.openkm.sdk4csharp.impl.DocumentImpl.isValidDocument | ( | String | docId | ) |
isValid
docId |
void com.openkm.sdk4csharp.impl.DocumentImpl.liveEditCheckin | ( | String | uuid, |
String | comment, | ||
int | increment | ||
) |
liveEditCheckin
uuid | |
comment | |
increment |
void com.openkm.sdk4csharp.impl.DocumentImpl.liveEditSetContent | ( | String | uuid, |
FileStream | fileStream | ||
) |
liveEditSetContent
uuid | |
fileStream |
LockInfo com.openkm.sdk4csharp.impl.DocumentImpl.lockDocument | ( | String | docId | ) |
lockDocument
docId |
void com.openkm.sdk4csharp.impl.DocumentImpl.mergePdf | ( | String | destinationUuid, |
String | docName, | ||
List< String > | uuids | ||
) |
mergePdf
destinationUuid | |
docName | |
uuids |
void com.openkm.sdk4csharp.impl.DocumentImpl.moveDocument | ( | String | docId, |
String | dstId | ||
) |
moveDocument
docId | |
dstId |
void com.openkm.sdk4csharp.impl.DocumentImpl.purgeDocument | ( | String | docId | ) |
purge
docId |
OCRRecognise com.openkm.sdk4csharp.impl.DocumentImpl.recognize | ( | String | uuid | ) |
recognize
uuid |
Document com.openkm.sdk4csharp.impl.DocumentImpl.renameDocument | ( | String | docId, |
String | newName | ||
) |
rename
docId | |
newName |
void com.openkm.sdk4csharp.impl.DocumentImpl.setAuthorizationToken | ( | String | authorizationToken | ) |
void com.openkm.sdk4csharp.impl.DocumentImpl.setDocumentDescription | ( | String | uuid, |
String | description | ||
) |
setDocumentDescription
uuid | |
description |
void com.openkm.sdk4csharp.impl.DocumentImpl.setDocumentDispositionStage | ( | String | uuid, |
long | stage | ||
) |
setDocumentDispositionStage
uuid | |
stage |
void com.openkm.sdk4csharp.impl.DocumentImpl.setDocumentNodeClass | ( | String | docId, |
long | ncId | ||
) |
setDocumentNodeClass
docId | |
title |
void com.openkm.sdk4csharp.impl.DocumentImpl.setDocumentTitle | ( | String | docId, |
String | title | ||
) |
setTitle
docId | |
title |
void com.openkm.sdk4csharp.impl.DocumentImpl.setLanguage | ( | String | uuid, |
String | lang | ||
) |
setLanguage
uuid | |
lang |
void com.openkm.sdk4csharp.impl.DocumentImpl.setProperties | ( | String | uuid, |
String | title, | ||
String | description, | ||
String | lang, | ||
List< String > | keywords, | ||
List< String > | categories | ||
) |
setProperties
uuid | |
title | |
description | |
lang | |
keywords | |
categories |
void com.openkm.sdk4csharp.impl.DocumentImpl.unlockDocument | ( | String | docId | ) |
unlockDocument
docId |
void com.openkm.sdk4csharp.impl.DocumentImpl.updateDocumentFromTemplate | ( | String | docId, |
String | dstId, | ||
Dictionary< String, String > | properties | ||
) |
updateDocumentFromTemplate
docId | |
dstId | |
properties |