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 DocumentInfo	CopyFrom (ICoreInfo coreInfo)
	Copies a document from another container. More...

override DocumentInfo	RefreshChild (DocumentInfo childInfo)

override Document	GetChild (DocumentInfo childInfo)

Public Member Functions inherited from Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< Document, DocumentInfo >
void	DisposeChild (ICoreObject coreObject)

bool	IsParentOf (ICoreObject coreObject)

abstract TChildInfo	RefreshChild (TChildInfo childInfo)

void	RefreshChildren ()

virtual TChild	GetChild (TChildInfo childInfo)

virtual OperationInfo	CanCreateChild ()

virtual TChildInfo	CreateChild ()

virtual OperationInfo	CanDeleteChild (TChildInfo childInfo)

virtual void	DeleteChild (TChildInfo childInfo)

virtual OperationInfo	CanMoveFrom (ICoreInfo coreInfo, bool deepCheck=true)

virtual TChildInfo	MoveFrom (ICoreInfo coreInfo)

virtual OperationInfo	CanCopyFrom (ICoreInfo coreInfo, bool deepCheck=true)

virtual TChildInfo	CopyFrom (ICoreInfo coreInfo)

void	RefreshInfos ()

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)

TChildInfo	RefreshChild (Predicate< TChildInfo > predicate)
	Refreshes all infos and returns the appropriate info. More...

Properties
ICoreObjectWithDocuments	Parent `[get]`

Additional Inherited Members
Public Attributes inherited from Ofcas.Lk.Api.Client.Core.CoreObjectWithChildren< Document, DocumentInfo >
IList< TChildInfo >	Infos

IList< TChildInfo >	ChildrenInfos

Detailed Description

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

Member Function Documentation

◆ CopyFrom()

override DocumentInfo Ofcas.Lk.Api.Client.Core.DocumentContainer.CopyFrom ( ICoreInfo coreInfo )

Copies a document from another container.

Parameters

coreInfo Specifies the document.

Returns: The document which should be copied.

◆ 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

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CopyFrom()

◆ CreateDocument()

◆ DeleteDocument()

◆ GetDocument()

◆ GetInfoResponse()