Ofcas.Lk.Api.Client.Core.DocumentContainer Class Reference

DocumentContainer gives access to manage documents. Documents can be used in projects (Project). More...

Inheritance diagram for Ofcas.Lk.Api.Client.Core.DocumentContainer:

Public Member Functions
Document	GetDocument (DocumentInfo documentInfo)
	Returns the corresponding document based on the given information data. More...
DocumentInfo	CreateDocument (string name, string suffix, DocumentType type, Stream content)
	Creates a document with the specific name, suffix, type and content. More...
void	DeleteDocument (DocumentInfo documentInfo)
	Deletes a document specified by an info object. More...
override Document	GetChild (DocumentInfo childInfo)
Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< Document, DocumentInfo >
void	RefreshInfos ()
virtual TChild	GetChild (TChildInfo childInfo)
virtual OperationInfo	CanCreateChild ()
virtual TChildInfo	CreateChild ()
virtual OperationInfo	CanDeleteChild (TChildInfo coreInfo)
virtual void	DeleteChild (TChildInfo coreInfo)
virtual OperationInfo	CanMoveFrom (TChildInfo coreInfo)
virtual TChildInfo	MoveFrom (TChildInfo coreInfo)
virtual OperationInfo	CanCopyFrom (TChildInfo coreInfo)
virtual TChildInfo	CopyFrom (TChildInfo coreInfo)
virtual OperationInfo	CanAdd (ICoreInfo coreInfo)
virtual TChildInfo	Add (ICoreInfo coreInfo)

Protected Member Functions
override CoreInfoResponse	GetInfoResponse ()
	Gets the info response from service. More...
virtual Document	CreateNewInstance (Guid coreObjectId, DocumentInfo documentInfo)
Protected Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< Document, DocumentInfo >
	CoreObjectWithChildren (IApiService apiService, Guid coreObjectId)

Properties
ICoreObject	Parent [get]
Properties inherited from Ofcas.Lk.Api.Client.Core.Interfaces.ICoreObjectWithParent< ICoreObject >
TParent	Parent [get]
	The parent of this object. More...

Additional Inherited Members
Public Attributes inherited from Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< Document, DocumentInfo >
IList< TChildInfo >	Infos
Protected Attributes inherited from Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< Document, DocumentInfo >
const string	NotSupportedCauseNotImplemented
	Default message for methods which are not supported because they are not implemented. More...

Detailed Description

DocumentContainer gives access to manage documents. Documents can be used in projects (Project).

Member Function Documentation

CreateDocument()

DocumentInfo Ofcas.Lk.Api.Client.Core.DocumentContainer.CreateDocument	(	string	name,
		string	suffix,
		DocumentType	type,
		Stream	content
	)

Creates a document with the specific name, suffix, type and content.

Parameters

name	Specifies the name of the document.
suffix	Specifies the suffix of the document.
type	Specifies the type of the document.
content	Specifies the content of the document.

Returns

Returns the newly created document as info object.

DeleteDocument()

void Ofcas.Lk.Api.Client.Core.DocumentContainer.DeleteDocument

(

DocumentInfo

documentInfo

)

Deletes a document specified by an info object.

Parameters

documentInfo

Specifies the document to be deleted.

GetDocument()

Document Ofcas.Lk.Api.Client.Core.DocumentContainer.GetDocument

(

DocumentInfo

documentInfo

)

Returns the corresponding document based on the given information data.

Parameters

documentInfo

The document information obtained through the CoreObject<T>.Infos function.

Returns

the Document

Exceptions

Exception

If getting document failed.

GetInfoResponse()

override CoreInfoResponse Ofcas.Lk.Api.Client.Core.DocumentContainer.GetInfoResponse ( )

protectedvirtual

Gets the info response from service.

Returns

Return the CoreInfoResponse.

Implements Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< Document, DocumentInfo >.

---

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

• Core/src/DocumentContainer.cs