Class DeploymentItem

Concrete implementation of IDeploymentItem. Should be implemented over the interface.

Inheritance

object

DeploymentItem

Implements

IDeploymentItem

INotifyPropertyChanged

ITypedItem

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.DeploymentApi.Editor

Assembly: Unity.Services.DeploymentApi.dll

Syntax

public class DeploymentItem : IDeploymentItem, INotifyPropertyChanged, ITypedItem

Fields

m_Name

Name of the deployment item.

Declaration

protected string m_Name

Field Value

Type	Description
string

m_Path

Path of the deployment item.

Declaration

protected string m_Path

Field Value

Type	Description
string

m_Progress

Progress of the deployment item.

Declaration

protected float m_Progress

Field Value

Type	Description
float

m_States

The asset state collection of the deployment item.

Declaration

protected ObservableCollection<AssetState> m_States

Field Value

Type	Description
ObservableCollection<AssetState>

m_Status

Status of the deployment item.

Declaration

protected DeploymentStatus m_Status

Field Value

Type	Description
DeploymentStatus

m_Type

Type of the deployment item.

Declaration

protected string m_Type

Field Value

Type	Description
string

Properties

Name

Represents the name with an extension.

Declaration

public virtual string Name { get; set; }

Property Value

Type	Description
string

Path

Represents the full path of a deployment item.

Declaration

public virtual string Path { get; set; }

Property Value

Type	Description
string

Progress

Represents the deployment progress of a deployment item. Is expected to be a value between 0 and 100.

Declaration

public virtual float Progress { get; set; }

Property Value

Type	Description
float

States

Represents possible states of the local asset(s) the item represents, including with regards to its validity, format or other.

Declaration

public ObservableCollection<AssetState> States { get; }

Property Value

Type	Description
ObservableCollection<AssetState>

Status

Represents the status of the item relative to what is available live.

Declaration

public virtual DeploymentStatus Status { get; set; }

Property Value

Type	Description
DeploymentStatus

Type

Represents the type of the deployment item.

Declaration

public string Type { get; set; }

Property Value

Type	Description
string

Methods

SetField<T>(ref T, T, Action<T>, string)

Sets the field and raises an OnPropertyChanged event.

Declaration

protected void SetField<T>(ref T field, T value, Action<T> onFieldChanged = null, string propertyName = null)

Parameters

Type	Name	Description
T	field	The field to set.
T	value	The value to set.
Action<T>	onFieldChanged	The callback.
string	propertyName	Name of the property to set.

Type Parameters

Name	Description
T	Type of the parameter.

Events

PropertyChanged

An event that tracks a change of a property of the deployment item.

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type	Description
PropertyChangedEventHandler

Implements

IDeploymentItem

INotifyPropertyChanged

ITypedItem

Extension Methods

DeploymentItemExtensions.SetStatusDescription(IDeploymentItem, string)

DeploymentItemExtensions.SetStatusDetail(IDeploymentItem, string)

DeploymentItemExtensions.SetStatusSeverity(IDeploymentItem, SeverityLevel)