Interface IDeploymentWindow

Provides access to the Deployment Window operations

Namespace: Unity.Services.DeploymentApi.Editor

Assembly: Unity.Services.DeploymentApi.dll

Syntax

public interface IDeploymentWindow

Methods

Check(IReadOnlyList<IDeploymentItem>)

Checks the associated Deployment Items if they exist in the DeploymentWindow. Only available if the DeploymentWindow is open.

Declaration

void Check(IReadOnlyList<IDeploymentItem> deploymentItems)

Parameters

Type	Name	Description
IReadOnlyList<IDeploymentItem>	deploymentItems	The deployment items to check

ClearChecked()

Clears the current Deployment Window checked state.

Declaration

void ClearChecked()

ClearSelection()

Clears the current Deployment Window selection. Only available if the DeploymentWindow is open.

Declaration

void ClearSelection()

Deploy(IReadOnlyList<IDeploymentItem>, CancellationToken)

Deploys the specified items

Declaration

Task<DeploymentResult<IDeploymentItem>> Deploy(IReadOnlyList<IDeploymentItem> items, CancellationToken token = default)

Parameters

Type	Name	Description
IReadOnlyList<IDeploymentItem>	items	The deployment items to be deployed
CancellationToken	token	Cancellation token for the operation

Returns

Type	Description
Task<DeploymentResult<IDeploymentItem>>	The DeploymentResult object

GetChecked()

Gets the currently selected items. Only available if the DeploymentWindow is open.

Declaration

List<IDeploymentItem> GetChecked()

Returns

Type	Description
List<IDeploymentItem>	The selected items.

GetCurrentDeployment()

Represents information about the ongoing Deployment operation

Declaration

DeploymentScope GetCurrentDeployment()

Returns

Type	Description
DeploymentScope	The current scope. Null, if no deployment in progress

GetDeploymentDefinitions()

Gets the deployment definitions that are currently available

Declaration

List<IDeploymentDefinitionItem> GetDeploymentDefinitions()

Returns

Type	Description
List<IDeploymentDefinitionItem>	The deployment definitions

GetFromFiles(IReadOnlyList<string>)

Gets the associated IDeploymentItems for the given paths. If no item is found, null will be returned in its ordinal position. If more than one item is found, a ICompositeItem will be returned instead.

Declaration

List<IDeploymentItem> GetFromFiles(IReadOnlyList<string> filePaths)

Parameters

Type	Name	Description
IReadOnlyList<string>	filePaths	The paths for which to find the associated IDeploymentItems

Returns

Type	Description
List<IDeploymentItem>	The items associated with the paths

GetSelected()

Gets the currently checked items. Only available if the DeploymentWindow is open.

Declaration

List<IDeploymentItem> GetSelected()

Returns

Type	Description
List<IDeploymentItem>	The selected items.

OpenWindow()

Opens the Deployment Window

Declaration

EditorWindow OpenWindow()

Returns

Type	Description
EditorWindow

Select(IReadOnlyList<IDeploymentItem>)

Selects the associated Deployment Items if they exist in the DeploymentWindow. Only available if the DeploymentWindow is open.

Declaration

void Select(IReadOnlyList<IDeploymentItem> deploymentItems)

Parameters

Type	Name	Description
IReadOnlyList<IDeploymentItem>	deploymentItems	The deployment items to select

Events

DeploymentEnded

This event is fired after a deployment has ended

Declaration

event Action<IReadOnlyList<IDeploymentItem>> DeploymentEnded

Event Type

Type	Description
Action<IReadOnlyList<IDeploymentItem>>

DeploymentStarting

This event is fired before when a deployment is triggered in the deployment window

Declaration

event Action<IReadOnlyList<IDeploymentItem>> DeploymentStarting

Event Type

Type	Description
Action<IReadOnlyList<IDeploymentItem>>

Extension Methods

DeploymentWindowExtensions.Deploy(IDeploymentWindow, IReadOnlyList<string>, CancellationToken)

DeploymentWindowExtensions.GetAllDeploymentItems(IDeploymentWindow, bool)