OKMRest  3.0
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)
 
void refreshConfiguration (String url)
 
void setAuthorizationToken (String authorizationToken)
 
System.IO.Stream doc2pdf (FileStream fileStream, String fileName)
 
System.IO.Stream imageConvert (FileStream fileStream, string fileName, List< string > paramss, string dstMimeType)
 
System.IO.Stream html2pdf (string url)
 
string doc2txt (FileStream fileStream, String fileName)
 
string img2txt (FileStream fileStream, String fileName)
 
string barcode2txt (FileStream fileStream, String fileName)
 
System.IO.Stream getThumbnail (string docId, string type)
 
string login (String user, String password)
 
Dictionary< String, int > getGrantedRoles (string uuid)
 
Dictionary< String, int > getGrantedUsers (string uuid)
 
List< String > getRoles ()
 
List< CommonUsergetUsers ()
 
CommonUser getUser (string userId)
 
List< CommonUsergetUsersByRole (string role)
 
List< String > getRolesByUser (string userId)
 
List< ProfilegetProfiles (bool filterByActive)
 
Profile getUserProfile (string userId)
 
void setUserProfile (string userId, long profileId)
 
void grantRole (string uuid, 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 uuid, string userId, int permissions, bool recursive)
 
void createUser (string user, string password, string email, string name, bool active)
 
void updateUser (string user, string password, string email, string name, bool active)
 
void updateRole (string role, bool active)
 
void assignRole (string user, string role)
 
void removeRole (string user, string role)
 
void createRole (string role, bool active)
 
void deleteUser (string user)
 
void deleteRole (string role)
 
void changeSecurity (String uuid, ChangeSecurity changeSecurity)
 
Document createDocument (String uuid, String name, FileStream fileStream)
 
void deleteDocument (string docId)
 
Document getDocumentProperties (string docId)
 
System.IO.Stream getContent (string docId)
 
System.IO.Stream getContentByVersion (string docId, string versionId)
 
string getExtractedText (string docId)
 
List< DocumentgetDocumentChildren (string fldId)
 
Document renameDocument (string docId, string newName)
 
void setProperties (String uuid, String title, String description, String lang, List< String > keywords, List< String > categories)
 
void setLanguage (string uuid, string lang)
 
void setDocumentTitle (string docId, string title)
 
void setNodeClass (string docId, long ncId)
 
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)
 
bean.Version checkin (string docId, string comment, Stream fileStream, int increment)
 
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, string newName)
 
long getVersionHistorySize (string docId)
 
bool isValidDocument (string docId)
 
string getDocumentPath (string uuid)
 
List< String > getDetectedLanguages ()
 
void extendedCopy (string docId, string dstId, string name, bool categories, bool keywords, bool propertyGroups, bool notes, bool wiki)
 
Document createFromTemplate (string docId, string dstPath, String language, bool categories, bool keywords, bool propertyGroups, bool notes, bool wiki, Dictionary< String, String > properties)
 
void updateFromTemplate (string docId, string dstId, Dictionary< String, String > properties)
 
string getAnnotations (string docId, string verName)
 
Stream getDifferences (string docId, string v1, string v2)
 
List< DocumentgetCheckedOut ()
 
void setDocumentDescription (String uuid, String description)
 
Folder createFolder (String uuid, String name)
 
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)
 
void copyFolder (string uuid, string dstId, string newName)
 
void extendedFolderCopy (string fldId, string dstId, string newName, bool categories, bool keywords, bool propertyGroups, bool notes, bool wiki)
 
ContentInfo getContentInfo (string fldId)
 
void purgeFolder (string fldId)
 
void setStyle (string fldId, long styleId)
 
void createMissingFolders (string fldPath)
 
void setFolderDescription (string uuid, string description)
 
Mail getMailProperties (string uuid)
 
void deleteMail (string mailId)
 
Mail renameMail (string uuid, string newName)
 
void moveMail (string uuid, string dstId)
 
bool isValidMail (string uuid)
 
string getMailPath (string uuid)
 
Document createAttachment (string uuid, string docName, FileStream fileStream)
 
void deleteAttachment (string uuid, string docId)
 
List< DocumentgetAttachments (string uuid)
 
void purgeMail (string uuid)
 
void copyMail (string uuid, string dstId, string newName)
 
void extendedMailCopy (string uuid, string dstId, bool categories, bool keywords, bool propertyGroups, bool notes, bool wiki, string newName)
 
List< MailgetMailChildren (string uuid)
 
Mail importEml (string dstId, string title, FileStream fileStream)
 
Mail importMsg (string uuid, string title, FileStream fileStream)
 
void setMailTitle (string uuid, string title)
 
void setMailNodeClass (String uuid, long ncId)
 
void sendMail (List< string > recipient, string subject, String body)
 
void sendMailWithAttachments (List< String > to, List< String > cc, List< String > bcc, List< String > replyTo, String subject, String body, List< String > docsId, String uuid)
 
void setMailDescription (String uuid, String description)
 
Stream getMailContent (String uuid)
 
Stream getMailThumbnail (String uuid, String type)
 
Note addNote (string uuid, string text)
 
Note getNote (string noteId)
 
void deleteNote (string noteId)
 
void setNote (string noteId, string text)
 
List< NotelistNotes (string uuid)
 
List< NoteHistorygetNotesHistory (String uuid)
 
List< bean.VersiongetVersionHistory (string uuid)
 
void restoreVersion (string uuid, string versionName)
 
void purgeVersionHistory (string uuid)
 
PromoteAsRecordEvaluation mayBePromotedAsRecordNode (string uuid, bool fullEvaluation)
 
void promoteAsRecord (string uuid)
 
bool isElectronicRecordPath (string uuid)
 
void degradeRecord (string uuid)
 
Record getElectronicRecordInPath (String uuid)
 
void subscribe (String uuid)
 
void unsubscribe (String uuid)
 
void importZip (String uuid, FileStream content)
 
Stream exportZip (List< String > uuids, bool background)
 
void addCategory (string uuid, string catId)
 
void removeCategory (string uuid, string catId)
 
void addKeyword (string uuid, string keyword)
 
void removeKeyword (string uuid, string keyword)
 
void setEncryption (string uuid, string cipherName)
 
void unsetEncryption (string uuid)
 
void setSigned (string uuid, bool signed)
 
void addGroup (string uuid, string grpName, Dictionary< String, String > propertiesMap)
 
void removeGroup (string uuid, string grpName)
 
List< PropertyGroupgetGroups (string uuid)
 
List< PropertyGroupgetAllGroups ()
 
Dictionary< string, string > getPropertyGroupProperties (string uuid, string grpName)
 
List< FormElementgetPropertyGroupForm (string grpName)
 
void setPropertyGroupProperties (string uuid, string grpName, Dictionary< String, String > properties)
 
bool hasGroup (string uuid, string grpName)
 
string getRegisteredDefinition ()
 
List< string > getSuggestions (string uuid, string grpName, string propName)
 
void registerDefinition (FileStream fileStream, String pgName)
 
Dictionary< String, String > getPropertyGroupPropertiesByVersion (String uuid, String grpName, String versionName)
 
List< PropertyGroupgetGroupsByVersion (String uuid, String versionName)
 
PropertyGroup getGroup (String grpName)
 
Record createRecord (String uuid, String name, String title, long nodeClass)
 
Record getRecordProperties (string uuid)
 
void deleteRecord (string uuid)
 
void purgeRecord (string uuid)
 
Record renameRecord (string uuid, string newName)
 
void moveRecord (string uuid, string dstId)
 
void copyRecord (string uuid, string dstId, string newName)
 
bool isValidRecord (string uuid)
 
List< RecordgetRecordChildren (string fldId)
 
LockInfo lockRecord (string uuid)
 
void unlockRecord (string uuid)
 
void forceUnlockRecord (string uuid)
 
void setRecordTitle (string uuid, string title)
 
void setRecordNodeClass (string uuid, long ncId)
 
string getRecordPath (string uuid)
 
void setRecordDispositionStage (String uuid, long stage)
 
void setRecordDescription (String uuid, String description)
 
Folder getRootFolder ()
 
Folder getTrashFolder ()
 
Folder getTrashFolderBase ()
 
Folder getTemplatesFolder ()
 
Folder getPersonalFolder ()
 
Folder getPersonalFolderBase ()
 
Folder getMailFolder ()
 
Folder getMailFolderBase ()
 
Folder getThesaurusFolder ()
 
Folder getCategoriesFolder ()
 
void purgeTrash ()
 
string getUpdateMessage ()
 
string getRepositoryUuid ()
 
bool hasNode (string nodeId)
 
string getNodePath (string uuid)
 
string getNodeUuid (string nodePath)
 
AppVersion getAppVersion ()
 
void copyAttributes (string nodeId, string dstId, bool categories, bool keywords, bool propertyGroups, bool notes, bool wiki)
 
ScriptExecutionResult executeScript (FileStream fileStream)
 
SqlQueryResults executeSqlQuery (FileStream fileStream)
 
HqlQueryResults executeHqlQuery (FileStream fileStream)
 
Dictionary< string, string > getTranslations (String lang, String module)
 
Configuration getConfiguration (string key)
 
List< ChangeLoggedgetChangeLog (string nodePath, DateTime modificationsFrom)
 
string getServerTime ()
 
List< RelationTypegetRelationTypes (string type)
 
void addRelation (string nodeAId, string nodeBId, long relTypeId)
 
void deleteRelation (long relationId)
 
List< RelationgetRelations (string uuid)
 
List< RelationGroupgetRelationGroups (string uuid)
 
void addRelationGroup (string uuid, string groupName, long type)
 
void addNodeToGroup (string uuid, long groupId)
 
void deleteItemFromGroup (string uuid, long groupId)
 
RelationGroup findRelationGroup (long groupId)
 
void setRelationGroupName (long groupId, string groupName)
 
List< RelationGroupgetAllRelationGroups ()
 
void deleteRelationGroup (long groupId)
 
List< QueryResultfind (QueryParams qp, String propertiesPlugin)
 
ResultSet findPaginated (QueryParams queryParams, int offset, int limit, String propertiesPlugin)
 
Dictionary< string, int > getKeywordMap (String[] filter)
 
List< DocumentgetCategorizedDocuments (string categoryId)
 
long saveSearch (QueryParams Params)
 
void updateSearch (QueryParams Params)
 
QueryParams getSearch (int qpId)
 
List< QueryParamsgetAllSearchs ()
 
void deleteSearch (int qpId)
 
QueryResultList findByQuery (string query, string propertiesPlugin)
 
ResultSet findByQueryPaginated (int offset, int limit, String query, string propertiesPlugin)
 
List< ReportgetReports (bool active)
 
Report getReport (long rpId)
 
Stream executeReport (long rpId, string format, Dictionary< string, string > param)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseConversion
Stream imageConvert (FileStream fileStream, String fileName, List< String > paramss, String dstMimeType)
 
Stream html2pdf (String url)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseDocument
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 setLanguage (String uuid, String lang)
 
void setDocumentTitle (String docId, String title)
 
void setNodeClass (String docId, long ncId)
 
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)
 
com.openkm.sdk4csharp.bean.Version checkin (String docId, String comment, Stream fileStream, int increment)
 
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, String newName)
 
long getVersionHistorySize (String docId)
 
Boolean isValidDocument (String docId)
 
String getDocumentPath (String uuid)
 
void extendedCopy (String docId, String dstId, String name, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki)
 
String getExtractedText (String docId)
 
Stream getThumbnail (String docId, String type)
 
Document createFromTemplate (String docId, String dstPath, String language, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki, Dictionary< String, String > properties)
 
void updateFromTemplate (String docId, String dstId, Dictionary< String, String > properties)
 
String getAnnotations (String docId, String verName)
 
Stream getDifferences (String docId, String v1, String v2)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseAuth
Dictionary< String, int > getGrantedRoles (String uuid)
 
Dictionary< String, int > getGrantedUsers (String uuid)
 
List< String > getRolesByUser (String userId)
 
CommonUser getUser (String userId)
 
List< CommonUsergetUsersByRole (String role)
 
void revokeRole (String uuid, String roleId, int permissions, Boolean recursive)
 
void revokeUser (String uuid, String userId, int permissions, Boolean recursive)
 
void grantRole (String uuid, String roleId, int permissions, Boolean recursive)
 
void grantUser (String nodeId, String user, int permissions, Boolean recursive)
 
void createUser (String userId, String password, String email, String name, Boolean active)
 
void deleteUser (String user)
 
void updateUser (String user, String password, String email, String name, Boolean active)
 
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)
 
List< ProfilegetProfiles (Boolean filterByActive)
 
Profile getUserProfile (String userId)
 
void setUserProfile (String userId, long profileId)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseFolder
void deleteFolder (String uuid)
 
Folder getFolderProperties (String uuid)
 
Folder renameFolder (String uuid, String newName)
 
void moveFolder (String uuid, String dstId)
 
List< FoldergetFolderChildren (String uuid)
 
Boolean isValidFolder (String uuid)
 
String getFolderPath (String uuid)
 
void copyFolder (String uuid, String dstId, String newName)
 
void extendedFolderCopy (String uuid, String dstId, String newName, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki)
 
ContentInfo getContentInfo (String uuid)
 
void purgeFolder (String uuid)
 
void setStyle (String uuid, long styleId)
 
void createMissingFolders (String fldPath)
 
void setFolderDescription (string uuid, String description)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseMail
Mail getMailProperties (String uuid)
 
void deleteMail (String uuid)
 
Mail renameMail (String uuid, String newName)
 
void moveMail (String uuid, String dstId)
 
List< MailgetMailChildren (String uuid)
 
Boolean isValidMail (String uuid)
 
String getMailPath (String uuid)
 
Document createAttachment (String uuid, String docName, FileStream fileStream)
 
void deleteAttachment (String uuid, String docId)
 
List< DocumentgetAttachments (String uuid)
 
void purgeMail (String uuid)
 
void copyMail (String uuid, String dstId, String newName)
 
void extendedMailCopy (String uuid, String dstId, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki, String newName)
 
Mail importEml (String dstId, String title, FileStream fileStream)
 
Mail importMsg (String uuid, String title, FileStream fileStream)
 
void setMailTitle (String uuid, String title)
 
void sendMail (List< String > recipient, String subject, String body)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseNote
Note addNote (String uuid, String text)
 
Note getNote (String noteId)
 
void deleteNote (String noteId)
 
void setNote (String noteId, String text)
 
List< NotelistNotes (String uuid)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseNode
List< bean.VersiongetVersionHistory (String uuid)
 
void restoreVersion (String uuid, String versionName)
 
void purgeVersionHistory (String uuid)
 
PromoteAsRecordEvaluation mayBePromotedAsRecordNode (String uuid, bool fullEvaluation)
 
void promoteAsRecord (String uuid)
 
Boolean isElectronicRecordPath (String uuid)
 
void degradeRecord (String uuid)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseProperty
void addCategory (String uuid, String catId)
 
void removeCategory (String uuid, String catId)
 
void addKeyword (String uuid, String keyword)
 
void removeKeyword (String uuid, String keyword)
 
void setEncryption (String uuid, String cipherName)
 
void unsetEncryption (String uuid)
 
void setSigned (String uuid, Boolean signed)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BasePropertyGroup
void addGroup (String uuid, String grpName, Dictionary< String, String > propertiesMap)
 
void removeGroup (String uuid, String grpName)
 
List< PropertyGroupgetGroups (String uuid)
 
Dictionary< string, string > getPropertyGroupProperties (String uuid, String grpName)
 
List< FormElementgetPropertyGroupForm (String grpName)
 
void setPropertyGroupProperties (String uuid, String grpName, Dictionary< String, String > properties)
 
Boolean hasGroup (String uuid, String grpName)
 
List< string > getSuggestions (String uuid, String grpName, String propName)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseRecord
Record getRecordProperties (String uuid)
 
void deleteRecord (String uuid)
 
void purgeRecord (String uuid)
 
Record renameRecord (String uuid, String newName)
 
void moveRecord (String uuid, String dstId)
 
void copyRecord (String uuid, String dstId, String newName)
 
Boolean isValidRecord (String uuid)
 
List< RecordgetRecordChildren (String fldId)
 
LockInfo lockRecord (String uuid)
 
void unlockRecord (String uuid)
 
void forceUnlockRecord (String uuid)
 
void setRecordTitle (String uuid, String title)
 
void setRecordNodeClass (String uuid, long ncId)
 
String getRecordPath (String uuid)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseRepository
Boolean hasNode (String uuid)
 
String getNodePath (String uuid)
 
String getNodeUuid (String nodePath)
 
void copyAttributes (String uuid, String dstId, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki)
 
Configuration getConfiguration (String key)
 
List< ChangeLoggedgetChangeLog (String nodePath, DateTime modificationsFrom)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseRelation
List< RelationTypegetRelationTypes (String type)
 
void addRelation (String nodeAId, String nodeBId, long relTypeId)
 
List< RelationgetRelations (String uuid)
 
List< RelationGroupgetRelationGroups (String uuid)
 
void addRelationGroup (String uuid, String groupName, long type)
 
void addNodeToGroup (String uuid, long groupId)
 
void deleteItemFromGroup (String uuid, long groupId)
 
void setRelationGroupName (long groupId, String groupName)
 

Constructor & Destructor Documentation

com.openkm.sdk4csharp.OKMWebservice20.OKMWebservice20 ( string  url)

Member Function Documentation

void com.openkm.sdk4csharp.OKMWebservice20.addCategory ( string  uuid,
string  catId 
)
void com.openkm.sdk4csharp.OKMWebservice20.addGroup ( string  uuid,
string  grpName,
Dictionary< String, String >  propertiesMap 
)
void com.openkm.sdk4csharp.OKMWebservice20.addKeyword ( string  uuid,
string  keyword 
)
void com.openkm.sdk4csharp.OKMWebservice20.addNodeToGroup ( string  uuid,
long  groupId 
)
Note com.openkm.sdk4csharp.OKMWebservice20.addNote ( string  uuid,
string  text 
)
void com.openkm.sdk4csharp.OKMWebservice20.addRelation ( string  nodeAId,
string  nodeBId,
long  relTypeId 
)
void com.openkm.sdk4csharp.OKMWebservice20.addRelationGroup ( string  uuid,
string  groupName,
long  type 
)
void com.openkm.sdk4csharp.OKMWebservice20.assignRole ( string  user,
string  role 
)
string com.openkm.sdk4csharp.OKMWebservice20.barcode2txt ( FileStream  fileStream,
String  fileName 
)
void com.openkm.sdk4csharp.OKMWebservice20.cancelCheckout ( string  docId)
void com.openkm.sdk4csharp.OKMWebservice20.changeSecurity ( String  uuid,
ChangeSecurity  changeSecurity 
)
bean.Version com.openkm.sdk4csharp.OKMWebservice20.checkin ( string  docId,
string  comment,
Stream  fileStream 
)
bean.Version com.openkm.sdk4csharp.OKMWebservice20.checkin ( string  docId,
string  comment,
Stream  fileStream,
int  increment 
)
void com.openkm.sdk4csharp.OKMWebservice20.checkout ( string  docId)
void com.openkm.sdk4csharp.OKMWebservice20.copyAttributes ( string  nodeId,
string  dstId,
bool  categories,
bool  keywords,
bool  propertyGroups,
bool  notes,
bool  wiki 
)
void com.openkm.sdk4csharp.OKMWebservice20.copyDocument ( string  docId,
string  dstId,
string  newName 
)
void com.openkm.sdk4csharp.OKMWebservice20.copyFolder ( string  uuid,
string  dstId,
string  newName 
)
void com.openkm.sdk4csharp.OKMWebservice20.copyMail ( string  uuid,
string  dstId,
string  newName 
)
void com.openkm.sdk4csharp.OKMWebservice20.copyRecord ( string  uuid,
string  dstId,
string  newName 
)
Document com.openkm.sdk4csharp.OKMWebservice20.createAttachment ( string  uuid,
string  docName,
FileStream  fileStream 
)
Document com.openkm.sdk4csharp.OKMWebservice20.createDocument ( String  uuid,
String  name,
FileStream  fileStream 
)
Folder com.openkm.sdk4csharp.OKMWebservice20.createFolder ( String  uuid,
String  name 
)
Document com.openkm.sdk4csharp.OKMWebservice20.createFromTemplate ( string  docId,
string  dstPath,
String  language,
bool  categories,
bool  keywords,
bool  propertyGroups,
bool  notes,
bool  wiki,
Dictionary< String, String >  properties 
)
void com.openkm.sdk4csharp.OKMWebservice20.createMissingFolders ( string  fldPath)
Record com.openkm.sdk4csharp.OKMWebservice20.createRecord ( String  uuid,
String  name,
String  title,
long  nodeClass 
)
void com.openkm.sdk4csharp.OKMWebservice20.createRole ( string  role,
bool  active 
)
void com.openkm.sdk4csharp.OKMWebservice20.createUser ( string  user,
string  password,
string  email,
string  name,
bool  active 
)
void com.openkm.sdk4csharp.OKMWebservice20.degradeRecord ( string  uuid)
void com.openkm.sdk4csharp.OKMWebservice20.deleteAttachment ( string  uuid,
string  docId 
)
void com.openkm.sdk4csharp.OKMWebservice20.deleteDocument ( string  docId)
void com.openkm.sdk4csharp.OKMWebservice20.deleteFolder ( string  fldId)
void com.openkm.sdk4csharp.OKMWebservice20.deleteItemFromGroup ( string  uuid,
long  groupId 
)
void com.openkm.sdk4csharp.OKMWebservice20.deleteMail ( string  mailId)
void com.openkm.sdk4csharp.OKMWebservice20.deleteNote ( string  noteId)
void com.openkm.sdk4csharp.OKMWebservice20.deleteRecord ( string  uuid)
void com.openkm.sdk4csharp.OKMWebservice20.deleteRelation ( long  relationId)
void com.openkm.sdk4csharp.OKMWebservice20.deleteRelationGroup ( long  groupId)
void com.openkm.sdk4csharp.OKMWebservice20.deleteRole ( string  role)
void com.openkm.sdk4csharp.OKMWebservice20.deleteSearch ( int  qpId)
void com.openkm.sdk4csharp.OKMWebservice20.deleteUser ( string  user)
System.IO.Stream com.openkm.sdk4csharp.OKMWebservice20.doc2pdf ( FileStream  fileStream,
String  fileName 
)
string com.openkm.sdk4csharp.OKMWebservice20.doc2txt ( FileStream  fileStream,
String  fileName 
)
HqlQueryResults com.openkm.sdk4csharp.OKMWebservice20.executeHqlQuery ( FileStream  fileStream)
Stream com.openkm.sdk4csharp.OKMWebservice20.executeReport ( long  rpId,
string  format,
Dictionary< string, string >  param 
)
ScriptExecutionResult com.openkm.sdk4csharp.OKMWebservice20.executeScript ( FileStream  fileStream)
SqlQueryResults com.openkm.sdk4csharp.OKMWebservice20.executeSqlQuery ( FileStream  fileStream)
Stream com.openkm.sdk4csharp.OKMWebservice20.exportZip ( List< String >  uuids,
bool  background 
)
void com.openkm.sdk4csharp.OKMWebservice20.extendedCopy ( string  docId,
string  dstId,
string  name,
bool  categories,
bool  keywords,
bool  propertyGroups,
bool  notes,
bool  wiki 
)
void com.openkm.sdk4csharp.OKMWebservice20.extendedFolderCopy ( string  fldId,
string  dstId,
string  newName,
bool  categories,
bool  keywords,
bool  propertyGroups,
bool  notes,
bool  wiki 
)
void com.openkm.sdk4csharp.OKMWebservice20.extendedMailCopy ( string  uuid,
string  dstId,
bool  categories,
bool  keywords,
bool  propertyGroups,
bool  notes,
bool  wiki,
string  newName 
)
List<QueryResult> com.openkm.sdk4csharp.OKMWebservice20.find ( QueryParams  qp,
String  propertiesPlugin 
)
QueryResultList com.openkm.sdk4csharp.OKMWebservice20.findByQuery ( string  query,
string  propertiesPlugin 
)
ResultSet com.openkm.sdk4csharp.OKMWebservice20.findByQueryPaginated ( int  offset,
int  limit,
String  query,
string  propertiesPlugin 
)
ResultSet com.openkm.sdk4csharp.OKMWebservice20.findPaginated ( QueryParams  queryParams,
int  offset,
int  limit,
String  propertiesPlugin 
)
RelationGroup com.openkm.sdk4csharp.OKMWebservice20.findRelationGroup ( long  groupId)
void com.openkm.sdk4csharp.OKMWebservice20.forceCancelCheckout ( string  docId)
void com.openkm.sdk4csharp.OKMWebservice20.forceUnlock ( string  docId)
void com.openkm.sdk4csharp.OKMWebservice20.forceUnlockRecord ( string  uuid)
List<PropertyGroup> com.openkm.sdk4csharp.OKMWebservice20.getAllGroups ( )
List<RelationGroup> com.openkm.sdk4csharp.OKMWebservice20.getAllRelationGroups ( )
List<QueryParams> com.openkm.sdk4csharp.OKMWebservice20.getAllSearchs ( )
string com.openkm.sdk4csharp.OKMWebservice20.getAnnotations ( string  docId,
string  verName 
)
AppVersion com.openkm.sdk4csharp.OKMWebservice20.getAppVersion ( )
List<Document> com.openkm.sdk4csharp.OKMWebservice20.getAttachments ( string  uuid)
Folder com.openkm.sdk4csharp.OKMWebservice20.getCategoriesFolder ( )
List<Document> com.openkm.sdk4csharp.OKMWebservice20.getCategorizedDocuments ( string  categoryId)
List<ChangeLogged> com.openkm.sdk4csharp.OKMWebservice20.getChangeLog ( string  nodePath,
DateTime  modificationsFrom 
)
List<Document> com.openkm.sdk4csharp.OKMWebservice20.getCheckedOut ( )
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 
)
ContentInfo com.openkm.sdk4csharp.OKMWebservice20.getContentInfo ( string  fldId)
List<String> com.openkm.sdk4csharp.OKMWebservice20.getDetectedLanguages ( )
Stream com.openkm.sdk4csharp.OKMWebservice20.getDifferences ( string  docId,
string  v1,
string  v2 
)
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)
Record com.openkm.sdk4csharp.OKMWebservice20.getElectronicRecordInPath ( String  uuid)
string com.openkm.sdk4csharp.OKMWebservice20.getExtractedText ( 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  uuid)
Dictionary<String, int> com.openkm.sdk4csharp.OKMWebservice20.getGrantedUsers ( string  uuid)
PropertyGroup com.openkm.sdk4csharp.OKMWebservice20.getGroup ( String  grpName)
List<PropertyGroup> com.openkm.sdk4csharp.OKMWebservice20.getGroups ( string  uuid)
List<PropertyGroup> com.openkm.sdk4csharp.OKMWebservice20.getGroupsByVersion ( String  uuid,
String  versionName 
)
Dictionary<string, int> com.openkm.sdk4csharp.OKMWebservice20.getKeywordMap ( String[]  filter)
LockInfo com.openkm.sdk4csharp.OKMWebservice20.getLockInfo ( string  docId)
List<Mail> com.openkm.sdk4csharp.OKMWebservice20.getMailChildren ( string  uuid)
Stream com.openkm.sdk4csharp.OKMWebservice20.getMailContent ( String  uuid)
Folder com.openkm.sdk4csharp.OKMWebservice20.getMailFolder ( )
Folder com.openkm.sdk4csharp.OKMWebservice20.getMailFolderBase ( )
string com.openkm.sdk4csharp.OKMWebservice20.getMailPath ( string  uuid)
Mail com.openkm.sdk4csharp.OKMWebservice20.getMailProperties ( string  uuid)
Stream com.openkm.sdk4csharp.OKMWebservice20.getMailThumbnail ( String  uuid,
String  type 
)
string com.openkm.sdk4csharp.OKMWebservice20.getNodePath ( string  uuid)
string com.openkm.sdk4csharp.OKMWebservice20.getNodeUuid ( string  nodePath)
Note com.openkm.sdk4csharp.OKMWebservice20.getNote ( string  noteId)
List<NoteHistory> com.openkm.sdk4csharp.OKMWebservice20.getNotesHistory ( String  uuid)
Folder com.openkm.sdk4csharp.OKMWebservice20.getPersonalFolder ( )
Folder com.openkm.sdk4csharp.OKMWebservice20.getPersonalFolderBase ( )
List<Profile> com.openkm.sdk4csharp.OKMWebservice20.getProfiles ( bool  filterByActive)
List<FormElement> com.openkm.sdk4csharp.OKMWebservice20.getPropertyGroupForm ( string  grpName)
Dictionary<string, string> com.openkm.sdk4csharp.OKMWebservice20.getPropertyGroupProperties ( string  uuid,
string  grpName 
)
Dictionary<String, String> com.openkm.sdk4csharp.OKMWebservice20.getPropertyGroupPropertiesByVersion ( String  uuid,
String  grpName,
String  versionName 
)
List<Record> com.openkm.sdk4csharp.OKMWebservice20.getRecordChildren ( string  fldId)
string com.openkm.sdk4csharp.OKMWebservice20.getRecordPath ( string  uuid)
Record com.openkm.sdk4csharp.OKMWebservice20.getRecordProperties ( string  uuid)
string com.openkm.sdk4csharp.OKMWebservice20.getRegisteredDefinition ( )
List<RelationGroup> com.openkm.sdk4csharp.OKMWebservice20.getRelationGroups ( string  uuid)
List<Relation> com.openkm.sdk4csharp.OKMWebservice20.getRelations ( string  uuid)
List<RelationType> com.openkm.sdk4csharp.OKMWebservice20.getRelationTypes ( string  type)
Report com.openkm.sdk4csharp.OKMWebservice20.getReport ( long  rpId)
List<Report> com.openkm.sdk4csharp.OKMWebservice20.getReports ( bool  active)
string com.openkm.sdk4csharp.OKMWebservice20.getRepositoryUuid ( )
List<String> com.openkm.sdk4csharp.OKMWebservice20.getRoles ( )
List<String> com.openkm.sdk4csharp.OKMWebservice20.getRolesByUser ( string  userId)
Folder com.openkm.sdk4csharp.OKMWebservice20.getRootFolder ( )
QueryParams com.openkm.sdk4csharp.OKMWebservice20.getSearch ( int  qpId)
string com.openkm.sdk4csharp.OKMWebservice20.getServerTime ( )
List<string> com.openkm.sdk4csharp.OKMWebservice20.getSuggestions ( string  uuid,
string  grpName,
string  propName 
)
Folder com.openkm.sdk4csharp.OKMWebservice20.getTemplatesFolder ( )
Folder com.openkm.sdk4csharp.OKMWebservice20.getThesaurusFolder ( )
System.IO.Stream com.openkm.sdk4csharp.OKMWebservice20.getThumbnail ( string  docId,
string  type 
)
Dictionary<string, string> com.openkm.sdk4csharp.OKMWebservice20.getTranslations ( String  lang,
String  module 
)
Folder com.openkm.sdk4csharp.OKMWebservice20.getTrashFolder ( )
Folder com.openkm.sdk4csharp.OKMWebservice20.getTrashFolderBase ( )
string com.openkm.sdk4csharp.OKMWebservice20.getUpdateMessage ( )
CommonUser com.openkm.sdk4csharp.OKMWebservice20.getUser ( string  userId)
Profile com.openkm.sdk4csharp.OKMWebservice20.getUserProfile ( string  userId)
List<CommonUser> com.openkm.sdk4csharp.OKMWebservice20.getUsers ( )
List<CommonUser> com.openkm.sdk4csharp.OKMWebservice20.getUsersByRole ( string  role)
List<bean.Version> com.openkm.sdk4csharp.OKMWebservice20.getVersionHistory ( string  uuid)
long com.openkm.sdk4csharp.OKMWebservice20.getVersionHistorySize ( string  docId)
void com.openkm.sdk4csharp.OKMWebservice20.grantRole ( string  uuid,
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  uuid,
string  grpName 
)
bool com.openkm.sdk4csharp.OKMWebservice20.hasNode ( string  nodeId)
System.IO.Stream com.openkm.sdk4csharp.OKMWebservice20.html2pdf ( string  url)
System.IO.Stream com.openkm.sdk4csharp.OKMWebservice20.imageConvert ( FileStream  fileStream,
string  fileName,
List< string >  paramss,
string  dstMimeType 
)
string com.openkm.sdk4csharp.OKMWebservice20.img2txt ( FileStream  fileStream,
String  fileName 
)
Mail com.openkm.sdk4csharp.OKMWebservice20.importEml ( string  dstId,
string  title,
FileStream  fileStream 
)
Mail com.openkm.sdk4csharp.OKMWebservice20.importMsg ( string  uuid,
string  title,
FileStream  fileStream 
)
void com.openkm.sdk4csharp.OKMWebservice20.importZip ( String  uuid,
FileStream  content 
)
bool com.openkm.sdk4csharp.OKMWebservice20.isCheckedOut ( string  docId)
bool com.openkm.sdk4csharp.OKMWebservice20.isElectronicRecordPath ( string  uuid)
bool com.openkm.sdk4csharp.OKMWebservice20.isLocked ( string  docId)
bool com.openkm.sdk4csharp.OKMWebservice20.isValidDocument ( string  docId)
bool com.openkm.sdk4csharp.OKMWebservice20.isValidFolder ( string  fldId)
bool com.openkm.sdk4csharp.OKMWebservice20.isValidMail ( string  uuid)
bool com.openkm.sdk4csharp.OKMWebservice20.isValidRecord ( string  uuid)
List<Note> com.openkm.sdk4csharp.OKMWebservice20.listNotes ( string  uuid)
LockInfo com.openkm.sdk4csharp.OKMWebservice20.lockDocument ( string  docId)
LockInfo com.openkm.sdk4csharp.OKMWebservice20.lockRecord ( string  uuid)
string com.openkm.sdk4csharp.OKMWebservice20.login ( String  user,
String  password 
)
PromoteAsRecordEvaluation com.openkm.sdk4csharp.OKMWebservice20.mayBePromotedAsRecordNode ( string  uuid,
bool  fullEvaluation 
)
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.moveMail ( string  uuid,
string  dstId 
)
void com.openkm.sdk4csharp.OKMWebservice20.moveRecord ( string  uuid,
string  dstId 
)
void com.openkm.sdk4csharp.OKMWebservice20.promoteAsRecord ( string  uuid)
void com.openkm.sdk4csharp.OKMWebservice20.purgeDocument ( string  docId)
void com.openkm.sdk4csharp.OKMWebservice20.purgeFolder ( string  fldId)
void com.openkm.sdk4csharp.OKMWebservice20.purgeMail ( string  uuid)
void com.openkm.sdk4csharp.OKMWebservice20.purgeRecord ( string  uuid)
void com.openkm.sdk4csharp.OKMWebservice20.purgeTrash ( )
void com.openkm.sdk4csharp.OKMWebservice20.purgeVersionHistory ( string  uuid)
void com.openkm.sdk4csharp.OKMWebservice20.refreshConfiguration ( String  url)
void com.openkm.sdk4csharp.OKMWebservice20.registerDefinition ( FileStream  fileStream,
String  pgName 
)
void com.openkm.sdk4csharp.OKMWebservice20.removeCategory ( string  uuid,
string  catId 
)
void com.openkm.sdk4csharp.OKMWebservice20.removeGroup ( string  uuid,
string  grpName 
)
void com.openkm.sdk4csharp.OKMWebservice20.removeKeyword ( string  uuid,
string  keyword 
)
void com.openkm.sdk4csharp.OKMWebservice20.removeRole ( string  user,
string  role 
)
Document com.openkm.sdk4csharp.OKMWebservice20.renameDocument ( string  docId,
string  newName 
)
Folder com.openkm.sdk4csharp.OKMWebservice20.renameFolder ( string  fldId,
string  newName 
)
Mail com.openkm.sdk4csharp.OKMWebservice20.renameMail ( string  uuid,
string  newName 
)
Record com.openkm.sdk4csharp.OKMWebservice20.renameRecord ( string  uuid,
string  newName 
)
void com.openkm.sdk4csharp.OKMWebservice20.restoreVersion ( string  uuid,
string  versionName 
)
void com.openkm.sdk4csharp.OKMWebservice20.revokeRole ( string  nodeId,
string  role,
int  permissions,
bool  recursive 
)
void com.openkm.sdk4csharp.OKMWebservice20.revokeUser ( string  uuid,
string  userId,
int  permissions,
bool  recursive 
)
long com.openkm.sdk4csharp.OKMWebservice20.saveSearch ( QueryParams  Params)
void com.openkm.sdk4csharp.OKMWebservice20.sendMail ( List< string >  recipient,
string  subject,
String  body 
)
void com.openkm.sdk4csharp.OKMWebservice20.sendMailWithAttachments ( List< String >  to,
List< String >  cc,
List< String >  bcc,
List< String >  replyTo,
String  subject,
String  body,
List< String >  docsId,
String  uuid 
)
void com.openkm.sdk4csharp.OKMWebservice20.setAuthorizationToken ( String  authorizationToken)
void com.openkm.sdk4csharp.OKMWebservice20.setDocumentDescription ( String  uuid,
String  description 
)
void com.openkm.sdk4csharp.OKMWebservice20.setDocumentTitle ( string  docId,
string  title 
)
void com.openkm.sdk4csharp.OKMWebservice20.setEncryption ( string  uuid,
string  cipherName 
)
void com.openkm.sdk4csharp.OKMWebservice20.setFolderDescription ( string  uuid,
string  description 
)
void com.openkm.sdk4csharp.OKMWebservice20.setLanguage ( string  uuid,
string  lang 
)
void com.openkm.sdk4csharp.OKMWebservice20.setMailDescription ( String  uuid,
String  description 
)
void com.openkm.sdk4csharp.OKMWebservice20.setMailNodeClass ( String  uuid,
long  ncId 
)
void com.openkm.sdk4csharp.OKMWebservice20.setMailTitle ( string  uuid,
string  title 
)
void com.openkm.sdk4csharp.OKMWebservice20.setNodeClass ( string  docId,
long  ncId 
)
void com.openkm.sdk4csharp.OKMWebservice20.setNote ( string  noteId,
string  text 
)
void com.openkm.sdk4csharp.OKMWebservice20.setProperties ( String  uuid,
String  title,
String  description,
String  lang,
List< String >  keywords,
List< String >  categories 
)
void com.openkm.sdk4csharp.OKMWebservice20.setPropertyGroupProperties ( string  uuid,
string  grpName,
Dictionary< String, String >  properties 
)
void com.openkm.sdk4csharp.OKMWebservice20.setRecordDescription ( String  uuid,
String  description 
)
void com.openkm.sdk4csharp.OKMWebservice20.setRecordDispositionStage ( String  uuid,
long  stage 
)
void com.openkm.sdk4csharp.OKMWebservice20.setRecordNodeClass ( string  uuid,
long  ncId 
)
void com.openkm.sdk4csharp.OKMWebservice20.setRecordTitle ( string  uuid,
string  title 
)
void com.openkm.sdk4csharp.OKMWebservice20.setRelationGroupName ( long  groupId,
string  groupName 
)
void com.openkm.sdk4csharp.OKMWebservice20.setSigned ( string  uuid,
bool  signed 
)
void com.openkm.sdk4csharp.OKMWebservice20.setStyle ( string  fldId,
long  styleId 
)
void com.openkm.sdk4csharp.OKMWebservice20.setUserProfile ( string  userId,
long  profileId 
)
void com.openkm.sdk4csharp.OKMWebservice20.subscribe ( String  uuid)
void com.openkm.sdk4csharp.OKMWebservice20.unlock ( string  docId)
void com.openkm.sdk4csharp.OKMWebservice20.unlockRecord ( string  uuid)
void com.openkm.sdk4csharp.OKMWebservice20.unsetEncryption ( string  uuid)
void com.openkm.sdk4csharp.OKMWebservice20.unsubscribe ( String  uuid)
void com.openkm.sdk4csharp.OKMWebservice20.updateFromTemplate ( string  docId,
string  dstId,
Dictionary< String, String >  properties 
)
void com.openkm.sdk4csharp.OKMWebservice20.updateRole ( string  role,
bool  active 
)
void com.openkm.sdk4csharp.OKMWebservice20.updateSearch ( QueryParams  Params)
void com.openkm.sdk4csharp.OKMWebservice20.updateUser ( string  user,
string  password,
string  email,
string  name,
bool  active 
)

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