com.openkm.sdk4csharp.definition.BaseDocument Interface Reference

Inheritance diagram for com.openkm.sdk4csharp.definition.BaseDocument:

Public Member Functions
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)
List< Document >	getDocumentChildren (String fldId)
Document	renameDocument (String docId, String newName)
void	setProperties (Document doc)
void	setLanguage (String docId, String lang)
void	setDocumentTitle (String docId, String title)
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, String newName)
long	getVersionHistorySize (String docId)
Boolean	isValidDocument (String docId)
String	getDocumentPath (String uuid)
List< String >	getDetectedLanguages ()
void	extendedCopy (String docId, String dstId, String name, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki)
Document	createFromTemplate (String docId, String dstPath, String language, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki, List< FormElement > properties)
void	updateFromTemplate (String docId, String dstId, List< FormElement > properties)
List< com.openkm.sdk4csharp.bean.Version >	getDocumentVersionHistory (String docId)
void	restoreDocumentVersion (String docId, String versionId)
void	purgeDocumentVersionHistory (String docId)
Document	createFromTemplateSimple (String docId, String dstPath, String language, Boolean categories, Boolean keywords, Boolean propertyGroups, Boolean notes, Boolean wiki, Dictionary< String, String > properties)
void	updateFromTemplateSimple (String docId, String dstId, Dictionary< String, String > properties)
String	getAnnotations (String docId, String verName)

Member Function Documentation

void com.openkm.sdk4csharp.definition.BaseDocument.cancelCheckout

(

String

docId

)

com.openkm.sdk4csharp.bean.Version com.openkm.sdk4csharp.definition.BaseDocument.checkin	(	String	docId,
		String	comment,
		Stream	fileStream
	)

void com.openkm.sdk4csharp.definition.BaseDocument.checkout

(

String

docId

)

void com.openkm.sdk4csharp.definition.BaseDocument.copyDocument	(	String	docId,
		String	dstId,
		String	newName
	)

Document com.openkm.sdk4csharp.definition.BaseDocument.createDocumentSimple	(	String	docPath,
		FileStream	fileStream
	)

Document com.openkm.sdk4csharp.definition.BaseDocument.createFromTemplate	(	String	docId,
		String	dstPath,
		String	language,
		Boolean	categories,
		Boolean	keywords,
		Boolean	propertyGroups,
		Boolean	notes,
		Boolean	wiki,
		List< FormElement >	properties
	)

Implemented in com.openkm.sdk4csharp.OKMWebservice20.

Document com.openkm.sdk4csharp.definition.BaseDocument.createFromTemplateSimple	(	String	docId,
		String	dstPath,
		String	language,
		Boolean	categories,
		Boolean	keywords,
		Boolean	propertyGroups,
		Boolean	notes,
		Boolean	wiki,
		Dictionary< String, String >	properties
	)

void com.openkm.sdk4csharp.definition.BaseDocument.deleteDocument

(

String

docId

)

void com.openkm.sdk4csharp.definition.BaseDocument.extendedCopy	(	String	docId,
		String	dstId,
		String	name,
		Boolean	categories,
		Boolean	keywords,
		Boolean	propertyGroups,
		Boolean	notes,
		Boolean	wiki
	)

void com.openkm.sdk4csharp.definition.BaseDocument.forceCancelCheckout

(

String

docId

)

void com.openkm.sdk4csharp.definition.BaseDocument.forceUnlock

(

String

docId

)

String com.openkm.sdk4csharp.definition.BaseDocument.getAnnotations	(	String	docId,
		String	verName
	)

Stream com.openkm.sdk4csharp.definition.BaseDocument.getContent

(

String

docId

)

Stream com.openkm.sdk4csharp.definition.BaseDocument.getContentByVersion	(	String	docId,
		String	versionId
	)

List<String> com.openkm.sdk4csharp.definition.BaseDocument.getDetectedLanguages

(

)

Implemented in com.openkm.sdk4csharp.OKMWebservice20.

List<Document> com.openkm.sdk4csharp.definition.BaseDocument.getDocumentChildren

(

String

fldId

)

String com.openkm.sdk4csharp.definition.BaseDocument.getDocumentPath

(

String

uuid

)

Document com.openkm.sdk4csharp.definition.BaseDocument.getDocumentProperties

(

String

docId

)

List<com.openkm.sdk4csharp.bean.Version> com.openkm.sdk4csharp.definition.BaseDocument.getDocumentVersionHistory

(

String

docId

)

String com.openkm.sdk4csharp.definition.BaseDocument.getExtractedText

(

String

docId

)

LockInfo com.openkm.sdk4csharp.definition.BaseDocument.getLockInfo

(

String

docId

)

Stream com.openkm.sdk4csharp.definition.BaseDocument.getThumbnail	(	String	docId,
		String	type
	)

long com.openkm.sdk4csharp.definition.BaseDocument.getVersionHistorySize

(

String

docId

)

Boolean com.openkm.sdk4csharp.definition.BaseDocument.isCheckedOut

(

String

docId

)

Boolean com.openkm.sdk4csharp.definition.BaseDocument.isLocked

(

String

docId

)

Boolean com.openkm.sdk4csharp.definition.BaseDocument.isValidDocument

(

String

docId

)

LockInfo com.openkm.sdk4csharp.definition.BaseDocument.lockDocument

(

String

docId

)

void com.openkm.sdk4csharp.definition.BaseDocument.moveDocument	(	String	docId,
		String	dstId
	)

void com.openkm.sdk4csharp.definition.BaseDocument.purgeDocument

(

String

docId

)

void com.openkm.sdk4csharp.definition.BaseDocument.purgeDocumentVersionHistory

(

String

docId

)

Document com.openkm.sdk4csharp.definition.BaseDocument.renameDocument	(	String	docId,
		String	newName
	)

void com.openkm.sdk4csharp.definition.BaseDocument.restoreDocumentVersion	(	String	docId,
		String	versionId
	)

void com.openkm.sdk4csharp.definition.BaseDocument.setDocumentTitle	(	String	docId,
		String	title
	)

void com.openkm.sdk4csharp.definition.BaseDocument.setLanguage	(	String	docId,
		String	lang
	)

void com.openkm.sdk4csharp.definition.BaseDocument.setProperties

(

Document

doc

)

Implemented in com.openkm.sdk4csharp.OKMWebservice20.

void com.openkm.sdk4csharp.definition.BaseDocument.unlock

(

String

docId

)

void com.openkm.sdk4csharp.definition.BaseDocument.updateFromTemplate	(	String	docId,
		String	dstId,
		List< FormElement >	properties
	)

void com.openkm.sdk4csharp.definition.BaseDocument.updateFromTemplateSimple	(	String	docId,
		String	dstId,
		Dictionary< String, String >	properties
	)

---

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

• BaseDocument.cs