View Source

Interface IComponent

Namespace: Umbraco.Cms.Core.Composing

Assembly: Umbraco.Core.dll

Syntax

public interface IComponent : IAsyncComponent

Methods

Initialize()

Initializes the component.

Declaration

void Initialize()

Terminate()

Terminates the component.

Declaration

void Terminate()

Explicit Interface Implementations

IAsyncComponent.InitializeAsync(Boolean, CancellationToken)

Initializes the component.

Declaration

Task IAsyncComponent.InitializeAsync(bool isRestarting, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Boolean	isRestarting	If set to true indicates Umbraco is restarting.
CancellationToken	cancellationToken	The cancellation token. Cancellation indicates that the start process has been aborted.

Returns

Type	Description
Task	A representing the asynchronous operation.

IAsyncComponent.TerminateAsync(Boolean, CancellationToken)

Terminates the component.

Declaration

Task IAsyncComponent.TerminateAsync(bool isRestarting, CancellationToken cancellationToken)

Parameters

Type	Name	Description
System.Boolean	isRestarting	If set to true indicates Umbraco is restarting.
CancellationToken	cancellationToken	The cancellation token. Cancellation indicates that the shutdown process should no longer be graceful.

Returns

Type	Description
Task	A representing the asynchronous operation.