View Source

Class ArtifactBase<TUdi>

Provides a base class to all artifacts.

Inheritance

System.Object

Namespace: Umbraco.Cms.Core.Deploy

Assembly: Umbraco.Core.dll

Syntax

public abstract class ArtifactBase<TUdi> : IArtifact, IArtifactSignature where TUdi : Udi

Type Parameters

Name	Description
TUdi

Constructors

ArtifactBase(TUdi, Nullable<IEnumerable<ArtifactDependency>>)

Declaration

protected ArtifactBase(TUdi udi, IEnumerable<ArtifactDependency>? dependencies = null)

Parameters

Type	Name	Description
TUdi	udi
System.Nullable<IEnumerable<ArtifactDependency>>	dependencies

Properties

Alias

Declaration

public string Alias { get; set; }

Property Value

Type	Description
System.String

Checksum

Declaration

public string Checksum { get; }

Property Value

Type	Description
System.String

Dependencies

Declaration

public IEnumerable<ArtifactDependency> Dependencies { get; set; }

Property Value

Type	Description
IEnumerable<ArtifactDependency>

Name

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

Udi

Declaration

public TUdi Udi { get; set; }

Property Value

Type	Description
TUdi

Methods

GetChecksum()

Declaration

protected abstract string GetChecksum()

Returns

Type	Description
System.String

ShouldSerializeChecksum()

Prevents the Checksum property from being serialized.

Declaration

public bool ShouldSerializeChecksum()

Returns

Type	Description
System.Boolean

Remarks

Note that we can't use here as that works only on fields, not properties. And we want to avoid using [JsonIgnore] as that would require an external dependency in Umbraco.Cms.Core. So using this method of excluding properties from serialized data, documented here: https://www.newtonsoft.com/json/help/html/ConditionalProperties.htm

Explicit Interface Implementations

IArtifactSignature.Udi

Declaration

Udi IArtifactSignature.Udi { get; }

Returns

Type	Description
Udi