Inheritance diagram for com.openkm.sdk4csharp.OKMWebservice:

[legend]

Collaboration diagram for com.openkm.sdk4csharp.OKMWebservice:

[legend]

Public Member Functions
void	refreshConfiguration (String host)

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)

Stream	html2pdf (String url)

string	doc2txt (FileStream fileStream, String fileName)

string	img2txt (FileStream fileStream, String fileName)

string	barcode2txt (FileStream fileStream, String fileName)

Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseDocument
Document	createDocument (String uuid, String name, 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 (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	setDocumentNodeClass (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	unlockDocument (String docId)

void	forceUnlockDocument (String docId)

Boolean	isLocked (String docId)

LockInfo	getLockInfo (String docId)

void	purgeDocument (String docId)

void	moveDocument (String docId, String dstId)

Document	copyDocument (String docId, String dstId, String newName)

long	getVersionHistorySize (String docId)

Boolean	isValidDocument (String docId)

String	getDocumentPath (String uuid)

List< String >	getDetectedLanguages ()

void	extendedDocumentCopy (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)

List< Document >	getCheckedOut ()

void	setDocumentDescription (String uuid, String description)

void	setDocumentDispositionStage (String uuid, long stage)

WizardNode	createWizardDocument (String uuid, String name, long nodeClass, FileStream fs)

bool	isOCRDataCaptureSupported (String uuid)

OCRRecognise	recognize (String uuid)

void	captureData (String uuid, long templateId)

String	generateDownloadToken (String uuid)

int	getNumberOfPages (String uuid)

String	getPageAsImage (String uuid, int pageNumber, int maxWidth, int maxHeight)

void	mergePdf (String destinationUuid, String docName, List< String > uuids)

Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseAuth
string	login (String user, String password)

void	setAuthorizationToken (String authorizationToken)

List< CommonUser >	getUsers ()

Dictionary< String, int >	getGrantedRoles (String uuid)

Dictionary< String, int >	getGrantedUsers (String uuid)

List< String >	getRoles ()

List< String >	getRolesByUser (String userId)

CommonUser	getUser (String userId)

List< CommonUser >	getUsersByRole (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	changeSecurity (String uuid, ChangeSecurity changeSecurity)

void	logout ()

GrantedUsersAndRolesItem	getGrantedUsersAndRoles (String uuid)

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< Profile >	getProfiles (Boolean filterByActive)

Profile	getUserProfile (String userId)

void	setUserProfile (String userId, long profileId)

void	setUserPermissions (String uuid, String userId, int permissions, bool recursive)

void	setRolePermissions (String uuid, String roleId, int permissions, bool recursive)

List< Tenant >	getUserTenants ()

void	setUserTenant (long tenantId)

Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseFolder
Folder	createFolder (String uuid, String name)

void	deleteFolder (String uuid)

Folder	getFolderProperties (String uuid)

Folder	renameFolder (String uuid, String newName)

void	moveFolder (String uuid, String dstId)

List< Folder >	getFolderChildren (String uuid)

Boolean	isValidFolder (String uuid)

String	getFolderPath (String uuid)

Folder	copyFolder (String uuid, String dstId, String newName)

Folder	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)

void	purgeMail (String uuid)

Mail	renameMail (String uuid, String newName)

void	moveMail (String uuid, String dstId)

Mail	copyMail (String uuid, String dstId, String newName)

Mail	extendedMailCopy (String uuid, String dstId, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki, String newName)

List< Mail >	getMailChildren (String uuid)

Boolean	isValidMail (String uuid)

String	getMailPath (String uuid)

void	setMailNodeClass (String uuid, long ncId)

Document	createAttachment (String uuid, String docName, FileStream fileStream)

void	deleteAttachment (String uuid, String docId)

List< Document >	getAttachments (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	sendMail (List< String > recipient, String subject, String body)

Mail	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)

void	setMailDispositionStage (String uuid, long stage)

WizardNode	createWizardMail (String uuid, String title, FileStream fileStream, String type)

NodeList	getMailsPaginated (int offset, int limit, MailFilterQuery filter, String orderColumn, bool orderAsc)

List< MailAccount >	getMailAccounts ()

MailServerMessages	getMailMessages (long accountId, long start)

void	addMailAccount (MailAccount mailAccount)

void	updateMailAccount (MailAccount mailAccount)

void	testMailAccount (MailAccount mailAccount)

void	deleteMailAccount (long mailAccountId)

void	importMailMessages (long mailAccountId, List< long > messageIds)

void	createMailFilter (long mailAccountId, MailFilter mailFilter)

void	updateMailFilter (MailFilter mailFilter)

void	deleteMailFilter (long mailFilterId)

void	createMailRule (long filterId, MailFilterRule rule)

void	updateMailRule (MailFilterRule rule)

void	deleteMailRule (long ruleId)

List< MailFilterRule >	getMailFilterRules (long filterId)

void	forwardEmail (String uuid, List< String > users, List< String > roles, List< String > mails, String message)

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< Note >	listNotes (String uuid)

List< NoteHistory >	getNotesHistory (String uuid)

Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseNode
List< bean.Version >	getVersionHistory (String uuid)

void	restoreVersion (String uuid, String versionName)

void	purgeVersionHistory (String uuid)

PromoteAsRecordEvaluation	mayBePromotedAsRecord (String uuid, bool fullEvaluation)

void	promoteAsRecord (String uuid)

Boolean	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)

Node	getNodeByUuid (String uuid)

ChildNodeList	getChildrenNodesPaginated (String uuid, int offset, int limit, String filter, String orderByField, bool orderAsc, List< int > filteredTypes)

ChildNodeList	getChildrenNodesByCategoryPaginated (String uuid, int offset, int limit, String filter, String orderByField, bool orderAsc, List< int > filteredTypes)

List< BreadCrumbItem >	getBreadcrumb (String uuid)

void	unZip (String uuid, String dstId)

List< Node >	getNodesFiltered (List< String > uuids)

ZipDownloadEvaluationResult	evaluateDownloadZip (List< String > uuids)

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< PropertyGroup >	getGroups (String uuid)

List< PropertyGroup >	getAllGroups ()

Dictionary< string, string >	getPropertyGroupProperties (String uuid, String grpName)

List< FormElement >	getPropertyGroupForm (String grpName)

void	setPropertyGroupProperties (String uuid, String grpName, Dictionary< String, String > properties)

Boolean	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< PropertyGroup >	getGroupsByVersion (String uuid, String versionName)

PropertyGroup	getGroup (String grpName)

Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseRecord
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)

Record	copyRecord (String uuid, String dstId, String newName)

Boolean	isValidRecord (String uuid)

List< Record >	getRecordChildren (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)

WizardNode	createWizardRecord (String uuid, String name, String title, long nodeClass)

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 uuid)

String	getNodePath (String uuid)

String	getNodeUuid (String nodePath)

AppVersion	getAppVersion ()

void	copyAttributes (String uuid, String dstId, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean 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< ChangeLogged >	getChangeLog (String nodePath, DateTime modificationsFrom)

String	getServerTime ()

Dictionary< String, String >	getAvailableLocales (String locale)

LicenseInfo	getLicenseInfo ()

Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseSearch
List< QueryResult >	find (QueryParams qp, String propertiesPlugin)

ResultSet	findPaginated (QueryParams queryParams, int offset, int limit, String propertiesPlugins)

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)

ResultSet	findByQueryPaginated (int offset, int limit, String query, String propertiesPlugin)

List< QueryResult >	findByQuery (String query, String propertiesPlugin)

List< QueryParams >	findAllDefaultByNodeClass (long ncId)

List< QueryResult >	findWithMetadata (QueryParams queryParams, String propertiesPlugin, List< String > groups)

ResultSet	findWithMetadataPaginated (QueryParams queryParams, int offset, int limit, String propertiesPlugin, List< String > groups)

Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseRelation
List< RelationType >	getRelationTypes (String type)

void	addRelation (String nodeAId, String nodeBId, long relTypeId)

void	deleteRelation (long relationId)

List< Relation >	getRelations (String uuid)

List< RelationGroup >	getRelationGroups (String uuid)

void	addRelationGroup (String uuid, String groupName, long type)

void	addNodeToGroup (String uuid, long groupId)

void	deleteRelationGroupItem (String uuid, long groupId)

RelationGroup	findRelationGroup (long groupId)

void	setRelationGroupName (long groupId, String groupName)

List< RelationGroup >	getAllRelationGroups ()

void	deleteRelationGroup (long groupId)

Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseReport
List< Report >	getReports (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.BaseWorkflow
void	registerProcessDefinition (FileStream fileStream)

void	deleteProcessDefinition (long pdId)

ProcessDefinition	getProcessDefinition (long pdId)

ProcessInstance	runProcessDefinition (long pdId, String uuid, List< FormElement > values)

List< ProcessInstance >	findProcessInstances (long pdId)

List< ProcessDefinition >	findAllProcessDefinitions ()

List< ProcessDefinition >	findLatestProcessDefinitions ()

ProcessDefinition	findLastProcessDefinition (String name)

ProcessInstance	getProcessInstance (long piId)

List< TaskInstance >	findUserTaskInstances ()

List< TaskInstance >	findTaskInstances (long piId)

void	setTaskInstanceValues (long tiId, String transName, List< FormElement > values)

TaskInstance	getTaskInstance (long tiId)

void	setTaskInstanceActorId (long tiId, String actorId)

void	startTaskInstance (long tiId)

void	endTaskInstance (long tiId, String transName)

Dictionary< String, List< FormElement > >	getProcessDefinitionForms (long pdId)

String	getProcessDefinitionImage (String pdId, String uuid)

List< TaskInstance >	findPooledTaskInstances ()

Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseActivity
ActivityList	findActivityLog (int page, int length, DateTime beginDate, DateTime endDate, String user, String action, String item)

List< String >	getActivityActions ()

Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseBookmark
List< Bookmark >	getUserBookmarks ()

void	createBookmark (String uuid, String name)

void	renameBookmark (int bookmarkId, String name)

void	deleteBookmark (int bookmarkId)

Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseDashboard
List< DashboardResult >	getUserCheckedOutDocuments ()

List< DashboardResult >	getUserLastModifiedDocuments ()

List< DashboardResult >	getUserLockedDocuments ()

List< DashboardResult >	getUserLockedRecords ()

List< DashboardResult >	getUserSubscribedDocuments ()

List< DashboardResult >	getUserSubscribedFolders ()

List< DashboardResult >	getUserSubscribedRecords ()

List< DashboardResult >	getUserLastCreatedDocuments ()

List< DashboardResult >	getUserLastCreatedFolders ()

List< DashboardResult >	getUserLastCreatedRecords ()

List< DashboardResult >	getUserLastDownloadedDocuments ()

List< DashboardResult >	getUserLastImportedMails ()

List< DashboardResult >	getUserLastImportedMailAttachments ()

Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseFilePlan
List< NodeClassSectionDefinition >	getRootSections ()

List< NodeClassSectionDefinition >	getRootSectionsFilteredBySecurity (int permissions)

List< NodeClassSectionDefinition >	getChildrenSections (long parentId)

List< NodeClassSectionDefinition >	getChildrenSectionsFilteredBySecurity (long parentId, int permissions)

List< NodeClass >	getChildrenClasses (long sectionId)

List< NodeClass >	getChildrenClassesFilteredBySecurity (long sectionId, int permissions)

NodeClass	findNodeClassByPk (long id)

List< NodeClass >	findElectronicRecordClasses ()

List< NodeClass >	findElectronicRecordClassesFilteredBySecurity (int permissions)

List< NodeClass >	findFilteredByCodeOrNameFilteredBySecurity (String code, String name, int permissions)

List< NodeClassSectionDefinition >	findSectionFiltered (String code, String name, int permissions)

List< NodeClassSectionDefinition >	getNodeClassBreadcrumb (long sectionId)

List< NodeClass >	findAllNodeClasses ()

Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseNotification
void	notify (List< String > uuids, List< String > users, List< String > roles, List< String > mails, String message, bool attachment)

Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseStamp
List< StampItem >	getAllStamps ()

StampText	getStampTextByPk (long id, String uuid)

StampImage	getStampImageByPk (long id, String uuid)

StampCoordinates	calculateStampCoordinates (long imgToStampWidth, long imgToStampHeight, long floatingDivWidth, long floatingDivHeight, String exprX, String exprY, String stampType, String stampAlign)

StampExpressions	calculateStampExpressions (long imgToStampWidth, long imgToStampHeight, long posX, long posY)

void	stampText (String uuid, String id)

void	stampImage (String uuid, String id)

void	stampImageCustom (String uuid, String id, String exprX, String exprY, String range, String personalStampUuid)

StampImageSize	calculateFlyImageDimensions (String uuid, long imgToStampWidth, long imgToStampHeight, long floatingImageWidth, long floatingImageHeight, int pageNumber)

List< Document >	getPersonalStamps ()

StampPersonalImage	getPersonalStampImage (String uuid, long id)

Public Member Functions inherited from com.openkm.sdk4csharp.definition.BaseTask
TaskList	getAssignedTasks (long projectId, long typeId, long statusId, String orderColumn, bool orderAsc, int offset, int limit, String subject)

TaskList	getActiveTasks (long projectId, long typeId, long statusId, String orderColumn, bool orderAsc, int offset, int limit, String subject)

TaskList	getFinishedTasks (long projectId, long typeId, long statusId, String orderColumn, bool orderAsc, int offset, int limit, String subject)

List< TaskStatus >	getTaskStatus ()

List< TaskProject >	getTaskProjects (bool filterActive)

List< TaskType >	getTaskTypes (bool filterActive)

long	getAssignedTasksCount (long statusId, long projectId, long typeId)

long	getActiveTasksCount (long statusId, long projectId, long typeId)

long	getFinishedTasksCount (long statusId, long projectId, long typeId)

Task	createTask (String subject, String start, String end, String description, String statusId, String projectId, String typeId, List< String > users, List< String > roles, List< String > externalUsers, List< String > relatedDocuments, List< String > relatedFolders, List< String > relatedRecords, List< String > relatedMails, String repeatExpression, String repeatUntil, String formatDate, int repeatTimes, String reminderStartUnit, int reminderStartValue, String reminderEndUnit, int reminderEndValue)

Task	updateTask (String taskId, String subject, String start, String end, String description, String statusId, String projectId, String typeId, List< String > users, List< String > roles, List< String > externalUsers, List< String > relatedDocuments, List< String > relatedFolders, List< String > relatedRecords, List< String > relatedMails, String owner, String repeatExpression, String repeatUntil, String formatDate, int repeatTimes, int progress, String reminderStartUnit, int reminderStartValue, String reminderEndUnit, int reminderEndValue)

Task	getTask (long taskId)

void	deleteTask (long taskId)

TaskProject	createTaskProject (String name, bool active, String description)

TaskProject	updateTaskProject (long projectId, bool active, String name, String description)

void	deleteTaskProject (long projectId)

TaskProject	getTaskProject (long projectId)

TaskType	createTaskType (String name, bool active, String description)

TaskType	updateTaskType (long typeId, bool active, String name, String description)

void	deleteTaskType (long typeId)

TaskType	getTaskType (long typeId)

TaskStatus	createTaskStatus (String name, bool finish)

TaskStatus	updateTaskStatus (long statusId, String name, bool finish)

void	deleteTaskStatus (long statusId)

TaskStatus	getTaskStatus (long statusId)

List< TaskNote >	getTaskNotes (long taskId)

TaskNote	createTaskNote (long taskId, String text)

TaskNote	updateTaskNote (long noteId, String text)

void	deleteTaskNote (long noteId)

Public Member Functions inherited from com.openkm.sdk4csharp.definition.BasePlugin
Stream	executePluginPostReturnFile (String className, Dictionary< String, String > parameters, FileStream fs)

Stream	executePluginGetReturnFile (String className, Dictionary< String, String > parameters)

Member Function Documentation

void com.openkm.sdk4csharp.OKMWebservice.refreshConfiguration ( String host )

Implemented in com.openkm.sdk4csharp.OKMWebservice20.

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

OKMWebservice.cs

Public Member Functions

Member Function Documentation