SDK for .NET  2.3.0
SDK for .NET
 All Classes Namespaces Files Functions Variables Properties
com.openkm.sdk4csharp.OKMWebservice Interface Reference
Inheritance diagram for com.openkm.sdk4csharp.OKMWebservice:
Collaboration diagram for com.openkm.sdk4csharp.OKMWebservice:

Additional Inherited Members

- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseConversion
Stream doc2pdf (String filePath)
 
Stream pdf2swf (String filePath)
 
Stream imageConvert (String filePath, String dstMimeType, String paramss)
 
Stream html2pdf (String url)
 
Stream doc2txt (String filePath)
 
Stream img2txt (String filePath)
 
Stream barcode2txt (String filePath)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseDocument
Document createDocument (String docPath, FileStream fileStream)
 
Document createDocumentSimple (String docPath, FileStream fileStream)
 
void deleteDocument (String docId)
 
Document getDocumentProperties (String docId)
 
Stream getContent (String docId)
 
Stream getContentByVersion (String docId, String versionId)
 
String getExtractedText (String docId)
 
Stream getThumbnail (String docId, String type)
 
DocumentList getDocumentChildren (String fldId)
 
Document renameDocument (String docId, String newName)
 
void setProperties (Document doc)
 
void setLanguage (String docId, String lang)
 
void setTitle (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)
 
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)
 
long getVersionHistorySize (String docId)
 
Boolean isValidDocument (String docId)
 
String getDocumentPath (String uuid)
 
LanguageList getDetectedLanguages ()
 
void extendedCopy (String docId, String dstId, String name, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki)
 
Document createFromTemplate (String docId, String dstId, String language, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki, SimplePropertyGroupList properties)
 
String updateFromTemplate (String docId, String dstId, SimplePropertyGroupList properties)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseAuth
GrantedRoleList getGrantedRoles (String nodeId)
 
GrantedUserList getGrantedUsers (String nodeId)
 
RoleList getRoles ()
 
UserList getUsers ()
 
String getMail (String user)
 
String getName (String user)
 
UserList getUsersByRole (String role)
 
RoleList getRolesByUser (String user)
 
ProfileList getProfiles (Boolean filterByActive)
 
Profile getUserProfile (String userId)
 
void setUserProfile (String userId, long profileId)
 
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 updateRole (String role, Boolean active)
 
void assignRole (String user, String role)
 
void removeRole (String user, String role)
 
void createRole (String role, Boolean active)
 
void deleteUser (String user)
 
void deleteRole (String role)
 
void changeSecurity (ChangeSecurity changeSecurity)
 
- 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)
 
FolderList getFolderChildren (String fldId)
 
Boolean isValidFolder (String fldId)
 
String getFolderPath (String uuid)
 
void copyFolder (String fldId, String dstId)
 
void extendedFolderCopy (String fldId, String dstId, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki)
 
ContentInfo getContentInfo (String fldId)
 
void purgeFolder (String fldId)
 
void setStyle (String fldId, long styleId)
 
- 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)
 
Document createAttachment (String mailId, String docName)
 
void deleteAttachment (String mailId, String docId)
 
DocumentList getAttachments (String mailId)
 
void purgeMail (String mailId)
 
void copyMail (String mailId, String dstId)
 
void extendedMailCopy (String mailId, String dstId, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki)
 
MailList getMailChildren (String fldId)
 
- 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)
 
NoteList noteList (String nodeId)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseNode
VersionList getVersionHistory (String nodeId)
 
void restoreVersion (String nodeId, String versionName)
 
void purgeVersionHistory (String nodeId)
 
PromoteAsRecordEvaluation mayBePromotedAsRecordNode (String nodeId)
 
void promoteAsRecord (String nodeId)
 
Boolean isElectronicRecordPath (String nodeId)
 
void degradeRecord (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)
 
PropertyGroupList getGroups (String nodeId)
 
PropertyGroupList getGroups (String nodeId, String versionName)
 
PropertyGroupList getAllGroups ()
 
FormElementComplexList getPropertyGroupProperties (String nodeId, String grpName)
 
FormElementComplexList getPropertyGroupProperties (String nodeId, String grpName, String versionName)
 
FormElementComplexList getPropertyGroupForm (String grpName)
 
void setPropertyGroupProperties (String nodeId, String grpName, FormElementComplexList properties)
 
void setPropertyGroupPropertiesSimple (String nodeId, String grpName, SimplePropertyGroupList properties)
 
Boolean hasGroup (String nodeId, String grpName)
 
String getRegisteredDefinition ()
 
SuggestionList getSuggestions (String nodeId, String grpName, String propName)
 
void registerDefinition (String pgDef)
 
SimplePropertyGroupList getPropertyGroupPropertiesSimple (String nodeId, String grpName)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseRecord
Record createRecord (Record rec)
 
Record getRecordProperties (String recId)
 
void deleteRecord (String recId)
 
void purgeRecord (String recId)
 
Record renameRecord (String recId, String newName)
 
void moveRecord (String recId, String dstId)
 
void copyRecord (String recId, String dstId)
 
Boolean isValidRecord (String recId)
 
RecordList getRecordChildren (String fldId)
 
LockInfo lockRecord (String recId)
 
void unlockRecord (String recId)
 
void forceUnlockRecord (String recId)
 
void setRecordTitle (String recId, String title)
 
void setRecordNodeClass (String recId, long ncId)
 
String getRecordPath (String uuid)
 
PromoteAsRecordEvaluation mayBePromotedAsRecord (String recId)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseRepository
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 ()
 
Boolean hasNode (String nodeId)
 
String getNodePath (String uuid)
 
String getNodeUuid (String nodePath)
 
AppVersion getAppVersion ()
 
void copyAttributes (String nodeId, String dstId, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseRelation
RelationTypeList getRelationTypes (String type)
 
void addRelation (String nodeAId, String nodeBId, long relTypeId)
 
void deleteRelation (long relationId)
 
RelationList getRelations (String nodeId)
 
RelationGroupList getRelationGroups (String nodeId)
 
void addRelationGroup (String nodeId, String groupName, long type)
 
void addNodeToGroup (String nodeId, long groupId)
 
void deleteGroup (String nodeId, long groupId)
 
RelationGroup findGroup (long groupId)
 
void setGroupName (long groupId, String groupName)
 
- Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseWorkflow
void registerProcessDefinition (FileStream fileStream)
 
void deleteProcessDefinition (long pdId)
 
ProcessDefinition getProcessDefinition (long pdId)
 
ProcessInstance runProcessDefinition (long pdId, String uuid, FormElementComplexList values)
 
ProcessInstanceList findProcessInstances (long pdId)
 
ProcessDefinitionList findAllProcessDefinitions ()
 
ProcessDefinitionList findLatestProcessDefinitions ()
 
ProcessDefinition findLastProcessDefinition (String name)
 
ProcessInstance getProcessInstance (long piId)
 
TaskInstanceList findUserTaskInstances ()
 
TaskInstanceList findTaskInstances (long piId)
 
void setTaskInstanceValues (long tiId, String transName, FormElementComplexList values)
 
TaskInstance getTaskInstance (long tiId)
 
void setTaskInstanceActorId (long tiId, String actorId)
 
void startTaskInstance (long tiId)
 
void endTaskInstance (long tiId, String transName)
 

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