OKMRest  1.1.2
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...
 
List< DocumentgetDocumentChildren (String fldId)
 getChildren More...
 
Document renameDocument (String docId, String newName)
 rename More...
 
void setProperties (Document doc)
 setProperties 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...
 
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)
 copy More...
 
long getVersionHistorySize (String docId)
 getVersionHistorySize More...
 
String getDocumentPath (String uuid)
 getPath 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...
 
- 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
void com.openkm.sdk4csharp.impl.DocumentImpl.checkout ( String  docId)

checkout

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

copy

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

createSimple

Parameters
srcPath
destPath
Returns
Document
void com.openkm.sdk4csharp.impl.DocumentImpl.deleteDocument ( String  docId)

delete

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

forceCancelCheckout

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

forceUnlock

Parameters
docId
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<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>
LockInfo com.openkm.sdk4csharp.impl.DocumentImpl.getLockInfo ( String  docId)

getLockInfo

Parameters
docId
Returns
LockInfo
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
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.setProperties ( Document  doc)

setProperties

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

unlock

Parameters
docId

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