OKMRest  2.6.0
OpenKM Rest
com.openkm.sdk4csharp.impl.DocumentImpl Class Reference
Inheritance diagram for com.openkm.sdk4csharp.impl.DocumentImpl:
Collaboration diagram for com.openkm.sdk4csharp.impl.DocumentImpl:

Public Member Functions

 DocumentImpl (String url, String user, String password)
 
Document createDocumentSimple (String docPath, 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< DocumentgetDocumentChildren (String fldId)
 getChildren More...
 
Document renameDocument (String docId, String newName)
 rename More...
 
void setProperties (Document doc)
 setProperties More...
 
void setLanguage (String docId, String lang)
 setLanguage More...
 
void setDocumentTitle (String docId, String title)
 setTitle More...
 
void setNodeClass (String docId, long ncId)
 setNodeClass 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 unlock (String docId)
 unlock More...
 
void forceUnlock (String docId)
 forceUnlock 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)
 move More...
 
void copyDocument (String docId, String dstId, String newName)
 copy 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 extendedCopy (String docId, String dstId, String name, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki)
 extendedCopy More...
 
Document createFromTemplate (String docId, String dstPath, String language, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki, List< FormElement > properties)
 createFromTemplate More...
 
void updateFromTemplate (String docId, String dstId, List< FormElement > properties)
 updateFromTemplate More...
 
List< com.openkm.sdk4csharp.bean.VersiongetDocumentVersionHistory (String docId)
 getVersionHistory More...
 
void restoreDocumentVersion (String docId, String versionId)
 restoreDocumentVersion More...
 
void purgeDocumentVersionHistory (String docId)
 purgeVersionHistory More...
 
Document createFromTemplateSimple (String docId, String dstPath, String language, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki, Dictionary< String, String > properties)
 createFromTemplateSimple More...
 
void updateFromTemplateSimple (String docId, String dstId, Dictionary< String, String > properties)
 updateFromTemplateSimple More...
 
String getAnnotations (String docId, String verName)
 getAnnotations More...
 
Stream getDifferences (String docId, String v1, String v2)
 getDifferences More...
 
List< DocumentgetCheckedOut ()
 getCheckedOut More...
 
- Public Member Functions inherited from com.openkm.sdk4csharp.impl.ClientImpl
RestClient getClient (String url, String user, String password)
 Authenticate More...
 

Constructor & Destructor Documentation

com.openkm.sdk4csharp.impl.DocumentImpl.DocumentImpl ( String  url,
String  user,
String  password 
)

Member Function Documentation

void com.openkm.sdk4csharp.impl.DocumentImpl.cancelCheckout ( String  docId)

cancelCheckout

Parameters
docId
com.openkm.sdk4csharp.bean.Version com.openkm.sdk4csharp.impl.DocumentImpl.checkin ( String  docId,
String  comment,
Stream  fileStream 
)

checkin

Parameters
docId
comment
srcPath
Returns
Version
com.openkm.sdk4csharp.bean.Version com.openkm.sdk4csharp.impl.DocumentImpl.checkin ( String  docId,
String  comment,
Stream  fileStream,
int  increment 
)

checkin

Parameters
docId
comment
fileStream
increment
Returns
Version
void com.openkm.sdk4csharp.impl.DocumentImpl.checkout ( String  docId)

checkout

Parameters
docId
void com.openkm.sdk4csharp.impl.DocumentImpl.copyDocument ( String  docId,
String  dstId,
String  newName 
)

copy

Parameters
docId
dstId
Document com.openkm.sdk4csharp.impl.DocumentImpl.createDocumentSimple ( String  docPath,
FileStream  fileStream 
)

createSimple

Parameters
srcPath
destPath
Returns
Document
Document com.openkm.sdk4csharp.impl.DocumentImpl.createFromTemplate ( String  docId,
String  dstPath,
String  language,
Boolean  categories,
Boolean  keywords,
Boolean  propertyGroups,
Boolean  notes,
Boolean  wiki,
List< FormElement properties 
)

createFromTemplate

Parameters
docId
dstPath
language
categories
keywords
propertyGroups
notes
wiki
properties
Returns
Document
Document com.openkm.sdk4csharp.impl.DocumentImpl.createFromTemplateSimple ( String  docId,
String  dstPath,
String  language,
Boolean  categories,
Boolean  keywords,
Boolean  propertyGroups,
Boolean  notes,
Boolean  wiki,
Dictionary< String, String >  properties 
)

createFromTemplateSimple

Parameters
docId
dstPath
languege
Returns
Document
void com.openkm.sdk4csharp.impl.DocumentImpl.deleteDocument ( String  docId)

delete

Parameters
docId
void com.openkm.sdk4csharp.impl.DocumentImpl.extendedCopy ( String  docId,
String  dstId,
String  name,
Boolean  categories,
Boolean  keywords,
Boolean  propertyGroups,
Boolean  notes,
Boolean  wiki 
)

extendedCopy

Parameters
docId
dstId
name
categories
keywords
propertyGroups
notes
wiki
void com.openkm.sdk4csharp.impl.DocumentImpl.forceCancelCheckout ( String  docId)

forceCancelCheckout

Parameters
docId
void com.openkm.sdk4csharp.impl.DocumentImpl.forceUnlock ( String  docId)

forceUnlock

Parameters
docId
String com.openkm.sdk4csharp.impl.DocumentImpl.getAnnotations ( String  docId,
String  verName 
)

getAnnotations

Parameters
docId
verName
Returns
List<Document> com.openkm.sdk4csharp.impl.DocumentImpl.getCheckedOut ( )

getCheckedOut

Parameters
fldId
Returns
Stream com.openkm.sdk4csharp.impl.DocumentImpl.getContent ( String  docId)

getContent

Parameters
docId
Returns
Stream
Stream com.openkm.sdk4csharp.impl.DocumentImpl.getContentByVersion ( String  docId,
String  versionId 
)

getContentByVersion

Parameters
docId
versionId
Returns
Stream
List<String> com.openkm.sdk4csharp.impl.DocumentImpl.getDetectedLanguages ( )

getDetectedLanguages

Parameters
docId
Returns
Stream com.openkm.sdk4csharp.impl.DocumentImpl.getDifferences ( String  docId,
String  v1,
String  v2 
)

getDifferences

Parameters
docId
v1
v2
Returns
List<Document> com.openkm.sdk4csharp.impl.DocumentImpl.getDocumentChildren ( String  fldId)

getChildren

Parameters
fldId
Returns
List<Document>
String com.openkm.sdk4csharp.impl.DocumentImpl.getDocumentPath ( String  uuid)

getPath

Parameters
docId
Returns
String
Document com.openkm.sdk4csharp.impl.DocumentImpl.getDocumentProperties ( String  docId)

getProperties

Parameters
docId
Returns
Document
List<com.openkm.sdk4csharp.bean.Version> com.openkm.sdk4csharp.impl.DocumentImpl.getDocumentVersionHistory ( String  docId)

getVersionHistory

Parameters
docId
Returns
List<Version>
String com.openkm.sdk4csharp.impl.DocumentImpl.getExtractedText ( String  docId)

getExtractedText

Parameters
docId
Returns
String
LockInfo com.openkm.sdk4csharp.impl.DocumentImpl.getLockInfo ( String  docId)

getLockInfo

Parameters
docId
Returns
LockInfo
Stream com.openkm.sdk4csharp.impl.DocumentImpl.getThumbnail ( String  docId,
String  type 
)

getThumbnail

Parameters
docIdDocId
Returns
Stream
long com.openkm.sdk4csharp.impl.DocumentImpl.getVersionHistorySize ( String  docId)

getVersionHistorySize

Parameters
docId
Returns
long
Boolean com.openkm.sdk4csharp.impl.DocumentImpl.isCheckedOut ( String  docId)

isCheckedOut

Parameters
docId
Returns
Boolean com.openkm.sdk4csharp.impl.DocumentImpl.isLocked ( String  docId)

isLocked

Parameters
docId
Returns
Boolean
Boolean com.openkm.sdk4csharp.impl.DocumentImpl.isValidDocument ( String  docId)

isValid

Parameters
docId
Returns
Boolean
LockInfo com.openkm.sdk4csharp.impl.DocumentImpl.lockDocument ( String  docId)

lockDocument

Parameters
docId
Returns
LockInfo
void com.openkm.sdk4csharp.impl.DocumentImpl.moveDocument ( String  docId,
String  dstId 
)

move

Parameters
docId
dstId
void com.openkm.sdk4csharp.impl.DocumentImpl.purgeDocument ( String  docId)

purge

Parameters
docId
void com.openkm.sdk4csharp.impl.DocumentImpl.purgeDocumentVersionHistory ( String  docId)

purgeVersionHistory

Parameters
docId
versionId
Document com.openkm.sdk4csharp.impl.DocumentImpl.renameDocument ( String  docId,
String  newName 
)

rename

Parameters
docId
newName
Returns
Document
void com.openkm.sdk4csharp.impl.DocumentImpl.restoreDocumentVersion ( String  docId,
String  versionId 
)

restoreDocumentVersion

Parameters
docId
versionId
void com.openkm.sdk4csharp.impl.DocumentImpl.setDocumentTitle ( String  docId,
String  title 
)

setTitle

Parameters
docId
title
void com.openkm.sdk4csharp.impl.DocumentImpl.setLanguage ( String  docId,
String  lang 
)

setLanguage

Parameters
docId
lang
void com.openkm.sdk4csharp.impl.DocumentImpl.setNodeClass ( String  docId,
long  ncId 
)

setNodeClass

Parameters
docId
title
void com.openkm.sdk4csharp.impl.DocumentImpl.setProperties ( Document  doc)

setProperties

Parameters
doc
void com.openkm.sdk4csharp.impl.DocumentImpl.unlock ( String  docId)

unlock

Parameters
docId
void com.openkm.sdk4csharp.impl.DocumentImpl.updateFromTemplate ( String  docId,
String  dstId,
List< FormElement properties 
)

updateFromTemplate

Parameters
docId
dstId
properties
Returns
String
void com.openkm.sdk4csharp.impl.DocumentImpl.updateFromTemplateSimple ( String  docId,
String  dstId,
Dictionary< String, String >  properties 
)

updateFromTemplateSimple

Parameters
docId
dstId
properties
Returns

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