View Source

Class ArtifactDeployState

Represent the state of an artifact being deployed.

Inheritance

System.Object

Namespace: Umbraco.Cms.Core.Deploy

Assembly: Umbraco.Core.dll

Syntax

public abstract class ArtifactDeployState

Properties

Artifact

Gets the artifact.

Declaration

public IArtifact Artifact { get; }

Property Value

Type	Description
IArtifact

Connector

Gets or sets the service connector in charge of deploying the artifact.

Declaration

public IServiceConnector Connector { get; set; }

Property Value

Type	Description
IServiceConnector

NextPass

Gets or sets the next pass number.

Declaration

public int NextPass { get; set; }

Property Value

Type	Description
System.Int32

Methods

Create<TArtifact, TEntity>(TArtifact, TEntity, IServiceConnector, Int32)

Creates a new instance of the ArtifactDeployState class from an artifact and an entity.

Declaration

public static ArtifactDeployState<TArtifact, TEntity> Create<TArtifact, TEntity>(TArtifact art, TEntity entity, IServiceConnector connector, int nextPass)
    where TArtifact : IArtifact

Parameters

Type	Name	Description
TArtifact	art	The artifact.
TEntity	entity	The entity.
IServiceConnector	connector	The service connector deploying the artifact.
System.Int32	nextPass	The next pass number.

Returns

Type	Description
ArtifactDeployState<TArtifact, TEntity>	A deploying artifact.

Type Parameters

Name	Description
TArtifact	The type of the artifact.
TEntity	The type of the entity.

GetArtifactAsIArtifact()

Gets the artifact as an IArtifact.

Declaration

protected abstract IArtifact GetArtifactAsIArtifact()

Returns

Type	Description
IArtifact	The artifact, as an IArtifact.

Remarks

This is because classes that inherit from this class cannot override the Artifact property with a property that specializes the return type, and so they need to 'new' the property.