OKMRest  1.2.3
OpenKM Rest
Public Member Functions | List of all members
com.openkm.sdk4csharp.OKMWebservice Interface Reference
Inheritance diagram for com.openkm.sdk4csharp.OKMWebservice:
Inheritance graph
[legend]
Collaboration diagram for com.openkm.sdk4csharp.OKMWebservice:
Collaboration graph
[legend]

Public Member Functions

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< Document > getDocumentChildren (String fldId)
 
Document renameDocument (String docId, String newName)
 
void setProperties (Document doc)
 
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.Version > getDocumentVersionHistory (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)
 
Boolean isValidDocument (String docId)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseAuth
Dictionary< String, int > getGrantedRoles (String nodeId)
 
Dictionary< String, int > getGrantedUsers (String nodeId)
 
List< String > getRoles ()
 
List< String > getUsers ()
 
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)
 
void createUser (String user, String password, String email, String name, Boolean active)
 
void updateUser (String user, String password, String email, String name, Boolean active)
 
void deleteUser (String user)
 
void createRole (String role, Boolean active)
 
void deleteRole (String role)
 
void updateRole (String role, Boolean active)
 
void assignRole (String user, String role)
 
void removeRole (String user, String role)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseFolder
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< Folder > getFolderChildren (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< Note > listNotes (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< PropertyGroup > getGroups (String nodeId)
 
List< PropertyGroup > getAllGroups ()
 
List< FormElement > getPropertyGroupProperties (String nodeId, String grpName)
 
List< FormElement > getPropertyGroupForm (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
Folder getRootFolder ()
 
Folder getTrashFolder ()
 
Folder getTemplatesFolder ()
 
Folder getPersonalFolder ()
 
Folder getMailFolder ()
 
Folder getThesaurusFolder ()
 
Folder getCategoriesFolder ()
 
void purgeTrash ()
 
String getUpdateMessage ()
 
String getRepositoryUuid ()
 
Boolean hasNode (String nodeId)
 
String getNodePath (String uuid)
 
String getNodeUuid (String nodePath)
 
AppVersion getAppVersion ()
 
SqlQueryResults executeSqlQuery (FileStream fileStream)
 
ScriptExecutionResult executeScript (FileStream fileStream)
 
List< string > executeHqlQuery (FileStream fileStream)
 
Configuration getConfiguration (String key)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseSearch
List< QueryResult > findByContent (String content)
 
List< QueryResult > findByName (String name)
 
List< QueryResult > findByKeywords (List< String > keywords)
 
List< QueryResult > find (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< Document > getCategorizedDocuments (String categoryId)
 
long saveSearch (QueryParams Params)
 
void updateSearch (QueryParams Params)
 
QueryParams getSearch (int qpId)
 
List< QueryParams > getAllSearchs ()
 
void deleteSearch (int qpId)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseConversion
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.definition.BaseMail
Mail createMail (Mail mail)
 
Mail getMailProperties (String mailId)
 
void deleteMail (String mailId)
 
Mail renameMail (String mailId, String newName)
 
void moveMail (String mailId, String dstId)
 
Boolean isValidMail (String mailId)
 
String getMailPath (String uuid)
 
List< Mail > getMailChildren (String fldId)
 
Mail importEml (String dstId, String title, FileStream fileStream)
 
Mail importMsg (String dstId, String title, FileStream fileStream)
 

Member Function Documentation

void com.openkm.sdk4csharp.OKMWebservice.refreshConfiguration ( String  host,
String  userName,
String  password 
)
The documentation for this interface was generated from the following file: