OKMRest  1.2.1
OpenKM Rest
com.openkm.sdk4csharp.OKMWebservice20 Class Reference
Inheritance diagram for com.openkm.sdk4csharp.OKMWebservice20:
Collaboration diagram for com.openkm.sdk4csharp.OKMWebservice20:

Public Member Functions

 OKMWebservice20 (string url, string user, string password)
 
void refreshConfiguration (string url, string user, string password)
 
Dictionary< String, int > getGrantedRoles (string nodeId)
 
Dictionary< String, int > getGrantedUsers (string nodeId)
 
string getMail (string user)
 
string getName (string user)
 
List< String > getRoles ()
 
List< String > getUsers ()
 
List< String > getUsersByRole (string role)
 
List< String > getRolesByUser (string user)
 
void grantRole (string nodeId, string role, int permissions, bool recursive)
 
void grantUser (string nodeId, string user, int permissions, bool recursive)
 
void revokeRole (string nodeId, string role, int permissions, bool recursive)
 
void revokeUser (string nodeId, string user, int permissions, bool recursive)
 
Document createDocumentSimple (string docPath, FileStream fileStream)
 
void deleteDocument (string docId)
 
Document getDocumentProperties (string docId)
 
System.IO.Stream getContent (string docId)
 
System.IO.Stream getContentByVersion (string docId, string versionId)
 
List< DocumentgetDocumentChildren (string fldId)
 
Document renameDocument (string docId, string newName)
 
void setProperties (Document doc)
 
void checkout (string docId)
 
void cancelCheckout (string docId)
 
void forceCancelCheckout (string docId)
 
bool isCheckedOut (string docId)
 
bean.Version checkin (string docId, string comment, Stream fileStream)
 
LockInfo lockDocument (string docId)
 
void unlock (string docId)
 
void forceUnlock (string docId)
 
bool isLocked (string docId)
 
LockInfo getLockInfo (string docId)
 
void purgeDocument (string docId)
 
void moveDocument (string docId, string dstId)
 
void copyDocument (string docId, string dstId)
 
long getVersionHistorySize (string docId)
 
string getDocumentPath (string uuid)
 
List< com.openkm.sdk4csharp.bean.VersiongetDocumentVersionHistory (string docId)
 
void restoreDocumentVersion (string docId, string versionId)
 
void purgeDocumentVersionHistory (string docId)
 
Folder createFolder (Folder fld)
 
Folder createFolderSimple (string fldPath)
 
void deleteFolder (string fldId)
 
Folder getFolderProperties (string fldId)
 
Folder renameFolder (string fldId, string newName)
 
void moveFolder (string fldId, string dstId)
 
List< FoldergetFolderChildren (string fldId)
 
bool isValidFolder (string fldId)
 
string getFolderPath (string uuid)
 
Note addNote (string nodeId, string text)
 
Note getNote (string noteId)
 
void deleteNote (string noteId)
 
void setNote (string noteId, string text)
 
List< NotelistNotes (string nodeId)
 
void addCategory (string nodeId, string catId)
 
void removeCategory (string nodeId, string catId)
 
void addKeyword (string nodeId, string keyword)
 
void removeKeyword (string nodeId, string keyword)
 
void setEncryption (string nodeId, string cipherName)
 
void unsetEncryption (string nodeId)
 
void setSigned (string nodeId, bool signed)
 
void addGroup (string nodeId, string grpName)
 
void removeGroup (string nodeId, string grpName)
 
List< PropertyGroupgetGroups (string nodeId)
 
List< PropertyGroupgetAllGroups ()
 
List< FormElementgetPropertyGroupProperties (string nodeId, string grpName)
 
List< FormElementgetPropertyGroupForm (string grpName)
 
void setPropertyGroupProperties (string nodeId, string grpName, List< FormElement > properties)
 
void setPropertyGroupPropertiesSimple (string nodeId, string grpName, Dictionary< String, String > properties)
 
bool hasGroup (string nodeId, string grpName)
 
Dictionary< String, String > getPropertyGroupPropertiesSimple (string nodeId, string grpName)
 
Folder getRootFolder ()
 
Folder getTrashFolder ()
 
Folder getTemplatesFolder ()
 
Folder getPersonalFolder ()
 
Folder getMailFolder ()
 
Folder getThesaurusFolder ()
 
Folder getCategoriesFolder ()
 
void purgeTrash ()
 
string getUpdateMessage ()
 
string getRepositoryUuid ()
 
bool hasNode (string nodeId)
 
string getNodePath (string uuid)
 
string getNodeUuid (string nodePath)
 
AppVersion getAppVersion ()
 
SqlQueryResults executeSqlQuery (FileStream fileStream)
 
Configuration getConfiguration (string key)
 
List< QueryResultfindByContent (string content)
 
List< QueryResultfindByName (string name)
 
List< QueryResultfindByKeywords (List< string > keywords)
 
List< QueryResultfind (QueryParams qp)
 
ResultSet findPaginated (QueryParams queryParams, int offset, int limit)
 
ResultSet findSimpleQueryPaginated (int offset, int limit, string statement)
 
ResultSet findMoreLikeThis (string uuid, int max)
 
Dictionary< string, int > getKeywordMap (String[] filter)
 
List< DocumentgetCategorizedDocuments (string categoryId)
 
Stream doc2pdf (FileStream fileStream, String fileName)
 
Stream imageConvert (FileStream fileStream, string fileName, List< string > paramss, string dstMimeType)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.OKMWebservice
void refreshConfiguration (String host, String userName, String password)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseDocument
Document createDocumentSimple (String docPath, 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 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)
 
List< com.openkm.sdk4csharp.bean.VersiongetDocumentVersionHistory (String docId)
 
LockInfo lockDocument (String docId)
 
void unlock (String docId)
 
void forceUnlock (String docId)
 
Boolean isLocked (String docId)
 
LockInfo getLockInfo (String docId)
 
void purgeDocument (String docId)
 
void moveDocument (String docId, String dstId)
 
void copyDocument (String docId, String dstId)
 
void restoreDocumentVersion (String docId, String versionId)
 
void purgeDocumentVersionHistory (String docId)
 
long getVersionHistorySize (String docId)
 
String getDocumentPath (String uuid)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseAuth
Dictionary< String, int > getGrantedRoles (String nodeId)
 
Dictionary< String, int > getGrantedUsers (String nodeId)
 
String getMail (String user)
 
String getName (String user)
 
List< String > getUsersByRole (String role)
 
List< String > getRolesByUser (String user)
 
void grantRole (String nodeId, String role, int permissions, Boolean recursive)
 
void grantUser (String nodeId, String user, int permissions, Boolean recursive)
 
void revokeRole (String nodeId, String role, int permissions, Boolean recursive)
 
void revokeUser (String nodeId, String user, int permissions, Boolean recursive)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseFolder
Folder createFolderSimple (String fldPath)
 
void deleteFolder (String fldId)
 
Folder getFolderProperties (String fldId)
 
Folder renameFolder (String fldId, String newName)
 
void moveFolder (String fldId, String dstId)
 
List< FoldergetFolderChildren (String fldId)
 
Boolean isValidFolder (String fldId)
 
String getFolderPath (String uuid)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseNote
Note addNote (String nodeId, String text)
 
Note getNote (String noteId)
 
void deleteNote (String noteId)
 
void setNote (String noteId, String text)
 
List< NotelistNotes (String nodeId)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseProperty
void addCategory (String nodeId, String catId)
 
void removeCategory (String nodeId, String catId)
 
void addKeyword (String nodeId, String keyword)
 
void removeKeyword (String nodeId, String keyword)
 
void setEncryption (String nodeId, String cipherName)
 
void unsetEncryption (String nodeId)
 
void setSigned (String nodeId, Boolean signed)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BasePropertyGroup
void addGroup (String nodeId, String grpName)
 
void removeGroup (String nodeId, String grpName)
 
List< PropertyGroupgetGroups (String nodeId)
 
List< FormElementgetPropertyGroupProperties (String nodeId, String grpName)
 
List< FormElementgetPropertyGroupForm (String grpName)
 
void setPropertyGroupProperties (String nodeId, String grpName, List< FormElement > properties)
 
void setPropertyGroupPropertiesSimple (String nodeId, String grpName, Dictionary< String, String > properties)
 
Boolean hasGroup (String nodeId, String grpName)
 
Dictionary< String, String > getPropertyGroupPropertiesSimple (String nodeId, String grpName)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseRepository
Boolean hasNode (String nodeId)
 
String getNodePath (String uuid)
 
String getNodeUuid (String nodePath)
 
Configuration getConfiguration (String key)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseConversion
Stream imageConvert (FileStream fileStream, String fileName, List< String > paramss, String dstMimeType)
 

Constructor & Destructor Documentation

com.openkm.sdk4csharp.OKMWebservice20.OKMWebservice20 ( string  url,
string  user,
string  password 
)

Member Function Documentation

void com.openkm.sdk4csharp.OKMWebservice20.addCategory ( string  nodeId,
string  catId 
)
void com.openkm.sdk4csharp.OKMWebservice20.addGroup ( string  nodeId,
string  grpName 
)
void com.openkm.sdk4csharp.OKMWebservice20.addKeyword ( string  nodeId,
string  keyword 
)
Note com.openkm.sdk4csharp.OKMWebservice20.addNote ( string  nodeId,
string  text 
)
void com.openkm.sdk4csharp.OKMWebservice20.cancelCheckout ( string  docId)
bean.Version com.openkm.sdk4csharp.OKMWebservice20.checkin ( string  docId,
string  comment,
Stream  fileStream 
)
void com.openkm.sdk4csharp.OKMWebservice20.checkout ( string  docId)
void com.openkm.sdk4csharp.OKMWebservice20.copyDocument ( string  docId,
string  dstId 
)
Document com.openkm.sdk4csharp.OKMWebservice20.createDocumentSimple ( string  docPath,
FileStream  fileStream 
)
Folder com.openkm.sdk4csharp.OKMWebservice20.createFolder ( Folder  fld)
Folder com.openkm.sdk4csharp.OKMWebservice20.createFolderSimple ( string  fldPath)
void com.openkm.sdk4csharp.OKMWebservice20.deleteDocument ( string  docId)
void com.openkm.sdk4csharp.OKMWebservice20.deleteFolder ( string  fldId)
void com.openkm.sdk4csharp.OKMWebservice20.deleteNote ( string  noteId)
Stream com.openkm.sdk4csharp.OKMWebservice20.doc2pdf ( FileStream  fileStream,
String  fileName 
)
SqlQueryResults com.openkm.sdk4csharp.OKMWebservice20.executeSqlQuery ( FileStream  fileStream)
List<QueryResult> com.openkm.sdk4csharp.OKMWebservice20.find ( QueryParams  qp)
List<QueryResult> com.openkm.sdk4csharp.OKMWebservice20.findByContent ( string  content)
List<QueryResult> com.openkm.sdk4csharp.OKMWebservice20.findByKeywords ( List< string >  keywords)
List<QueryResult> com.openkm.sdk4csharp.OKMWebservice20.findByName ( string  name)
ResultSet com.openkm.sdk4csharp.OKMWebservice20.findMoreLikeThis ( string  uuid,
int  max 
)
ResultSet com.openkm.sdk4csharp.OKMWebservice20.findPaginated ( QueryParams  queryParams,
int  offset,
int  limit 
)
ResultSet com.openkm.sdk4csharp.OKMWebservice20.findSimpleQueryPaginated ( int  offset,
int  limit,
string  statement 
)
void com.openkm.sdk4csharp.OKMWebservice20.forceCancelCheckout ( string  docId)
void com.openkm.sdk4csharp.OKMWebservice20.forceUnlock ( string  docId)
List<PropertyGroup> com.openkm.sdk4csharp.OKMWebservice20.getAllGroups ( )
AppVersion com.openkm.sdk4csharp.OKMWebservice20.getAppVersion ( )
Folder com.openkm.sdk4csharp.OKMWebservice20.getCategoriesFolder ( )
List<Document> com.openkm.sdk4csharp.OKMWebservice20.getCategorizedDocuments ( string  categoryId)
Configuration com.openkm.sdk4csharp.OKMWebservice20.getConfiguration ( string  key)
System.IO.Stream com.openkm.sdk4csharp.OKMWebservice20.getContent ( string  docId)
System.IO.Stream com.openkm.sdk4csharp.OKMWebservice20.getContentByVersion ( string  docId,
string  versionId 
)
List<Document> com.openkm.sdk4csharp.OKMWebservice20.getDocumentChildren ( string  fldId)
string com.openkm.sdk4csharp.OKMWebservice20.getDocumentPath ( string  uuid)
Document com.openkm.sdk4csharp.OKMWebservice20.getDocumentProperties ( string  docId)
List<com.openkm.sdk4csharp.bean.Version> com.openkm.sdk4csharp.OKMWebservice20.getDocumentVersionHistory ( string  docId)
List<Folder> com.openkm.sdk4csharp.OKMWebservice20.getFolderChildren ( string  fldId)
string com.openkm.sdk4csharp.OKMWebservice20.getFolderPath ( string  uuid)
Folder com.openkm.sdk4csharp.OKMWebservice20.getFolderProperties ( string  fldId)
Dictionary<String, int> com.openkm.sdk4csharp.OKMWebservice20.getGrantedRoles ( string  nodeId)
Dictionary<String, int> com.openkm.sdk4csharp.OKMWebservice20.getGrantedUsers ( string  nodeId)
List<PropertyGroup> com.openkm.sdk4csharp.OKMWebservice20.getGroups ( string  nodeId)
Dictionary<string, int> com.openkm.sdk4csharp.OKMWebservice20.getKeywordMap ( String[]  filter)
LockInfo com.openkm.sdk4csharp.OKMWebservice20.getLockInfo ( string  docId)
string com.openkm.sdk4csharp.OKMWebservice20.getMail ( string  user)
Folder com.openkm.sdk4csharp.OKMWebservice20.getMailFolder ( )
string com.openkm.sdk4csharp.OKMWebservice20.getName ( string  user)
string com.openkm.sdk4csharp.OKMWebservice20.getNodePath ( string  uuid)
string com.openkm.sdk4csharp.OKMWebservice20.getNodeUuid ( string  nodePath)
Note com.openkm.sdk4csharp.OKMWebservice20.getNote ( string  noteId)
Folder com.openkm.sdk4csharp.OKMWebservice20.getPersonalFolder ( )
List<FormElement> com.openkm.sdk4csharp.OKMWebservice20.getPropertyGroupForm ( string  grpName)
List<FormElement> com.openkm.sdk4csharp.OKMWebservice20.getPropertyGroupProperties ( string  nodeId,
string  grpName 
)
Dictionary<String, String> com.openkm.sdk4csharp.OKMWebservice20.getPropertyGroupPropertiesSimple ( string  nodeId,
string  grpName 
)
string com.openkm.sdk4csharp.OKMWebservice20.getRepositoryUuid ( )
List<String> com.openkm.sdk4csharp.OKMWebservice20.getRoles ( )
List<String> com.openkm.sdk4csharp.OKMWebservice20.getRolesByUser ( string  user)
Folder com.openkm.sdk4csharp.OKMWebservice20.getRootFolder ( )
Folder com.openkm.sdk4csharp.OKMWebservice20.getTemplatesFolder ( )
Folder com.openkm.sdk4csharp.OKMWebservice20.getThesaurusFolder ( )
Folder com.openkm.sdk4csharp.OKMWebservice20.getTrashFolder ( )
string com.openkm.sdk4csharp.OKMWebservice20.getUpdateMessage ( )
List<String> com.openkm.sdk4csharp.OKMWebservice20.getUsers ( )
List<String> com.openkm.sdk4csharp.OKMWebservice20.getUsersByRole ( string  role)
long com.openkm.sdk4csharp.OKMWebservice20.getVersionHistorySize ( string  docId)
void com.openkm.sdk4csharp.OKMWebservice20.grantRole ( string  nodeId,
string  role,
int  permissions,
bool  recursive 
)
void com.openkm.sdk4csharp.OKMWebservice20.grantUser ( string  nodeId,
string  user,
int  permissions,
bool  recursive 
)
bool com.openkm.sdk4csharp.OKMWebservice20.hasGroup ( string  nodeId,
string  grpName 
)
bool com.openkm.sdk4csharp.OKMWebservice20.hasNode ( string  nodeId)
Stream com.openkm.sdk4csharp.OKMWebservice20.imageConvert ( FileStream  fileStream,
string  fileName,
List< string >  paramss,
string  dstMimeType 
)
bool com.openkm.sdk4csharp.OKMWebservice20.isCheckedOut ( string  docId)
bool com.openkm.sdk4csharp.OKMWebservice20.isLocked ( string  docId)
bool com.openkm.sdk4csharp.OKMWebservice20.isValidFolder ( string  fldId)
List<Note> com.openkm.sdk4csharp.OKMWebservice20.listNotes ( string  nodeId)
LockInfo com.openkm.sdk4csharp.OKMWebservice20.lockDocument ( string  docId)
void com.openkm.sdk4csharp.OKMWebservice20.moveDocument ( string  docId,
string  dstId 
)
void com.openkm.sdk4csharp.OKMWebservice20.moveFolder ( string  fldId,
string  dstId 
)
void com.openkm.sdk4csharp.OKMWebservice20.purgeDocument ( string  docId)
void com.openkm.sdk4csharp.OKMWebservice20.purgeDocumentVersionHistory ( string  docId)
void com.openkm.sdk4csharp.OKMWebservice20.purgeTrash ( )
void com.openkm.sdk4csharp.OKMWebservice20.refreshConfiguration ( string  url,
string  user,
string  password 
)
void com.openkm.sdk4csharp.OKMWebservice20.removeCategory ( string  nodeId,
string  catId 
)
void com.openkm.sdk4csharp.OKMWebservice20.removeGroup ( string  nodeId,
string  grpName 
)
void com.openkm.sdk4csharp.OKMWebservice20.removeKeyword ( string  nodeId,
string  keyword 
)
Document com.openkm.sdk4csharp.OKMWebservice20.renameDocument ( string  docId,
string  newName 
)
Folder com.openkm.sdk4csharp.OKMWebservice20.renameFolder ( string  fldId,
string  newName 
)
void com.openkm.sdk4csharp.OKMWebservice20.restoreDocumentVersion ( string  docId,
string  versionId 
)
void com.openkm.sdk4csharp.OKMWebservice20.revokeRole ( string  nodeId,
string  role,
int  permissions,
bool  recursive 
)
void com.openkm.sdk4csharp.OKMWebservice20.revokeUser ( string  nodeId,
string  user,
int  permissions,
bool  recursive 
)
void com.openkm.sdk4csharp.OKMWebservice20.setEncryption ( string  nodeId,
string  cipherName 
)
void com.openkm.sdk4csharp.OKMWebservice20.setNote ( string  noteId,
string  text 
)
void com.openkm.sdk4csharp.OKMWebservice20.setProperties ( Document  doc)
void com.openkm.sdk4csharp.OKMWebservice20.setPropertyGroupProperties ( string  nodeId,
string  grpName,
List< FormElement properties 
)
void com.openkm.sdk4csharp.OKMWebservice20.setPropertyGroupPropertiesSimple ( string  nodeId,
string  grpName,
Dictionary< String, String >  properties 
)
void com.openkm.sdk4csharp.OKMWebservice20.setSigned ( string  nodeId,
bool  signed 
)
void com.openkm.sdk4csharp.OKMWebservice20.unlock ( string  docId)
void com.openkm.sdk4csharp.OKMWebservice20.unsetEncryption ( string  nodeId)

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