Version: 2022.3
LanguageEnglish
  • C#

Task

class in UnityEditor.VersionControl

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

A Task describes an instance of a version control operation.

An object of this type allows you to process operations such as Provider.Checkout, Provider.GetLatest, and Provider.Submit. Unity creates this item almost every time you ask Provider to perform an action. Task objects, that version control operations return, execute in the background and don't always finish immediately, use Task.Wait if you need to wait for them to finish.

Properties

assetListThe result of some types of tasks.
changeSetsList of changesets returned by some tasks.
descriptionA short description of the current task.
messagesMay contain messages from the version control plugins.
progressPctA progress percentage for the current task.
resultCodeSome task return result codes, these are stored here.
secondsSpentTotal time spent in task since the task was started.
successGet whether or not the task was completed succesfully.
textWill contain the result of the Provider.ChangeSetDescription task.

Public Methods

SetCompletionActionUpon completion of a task a completion task will be performed if it is set.
WaitA blocking wait for the task to complete.