Version: Unity 6.2 (6000.2)
LanguageEnglish
  • C#

Request

class in UnityEditor.PackageManager.Requests


Implements interfaces:ISerializationCallbackReceiver

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

Switch to Manual

Description

Base class for all Package Manager asynchronous operations. Use this class to track the status and results of package operations, such as adding, removing, or updating packages.

  • All Client (such as Client.Add, Client.Remove, and Client.List) return an object derived from the Request class.
  • Check the IsCompleted property to know when the operation is done.
  • Always check the Status property of the Request for a StatusCode of Success before accessing results to make sure the operation was successful.
using UnityEngine;
using UnityEditor.PackageManager;
using UnityEditor.PackageManager.Requests;

[ExecuteInEditMode] public class RequestExample : MonoBehaviour { ListRequest m_Request; void Start() { Debug.Log("Requesting packages list..."); m_Request = Client.List(); }

void Update() { if (m_Request != null && m_Request.IsCompleted) { if (m_Request.Status == StatusCode.Success) { foreach (var package in m_Request.Result) { Debug.Log($"Package: {package.name} ({package.version})"); } } else { Debug.Log($"Package list request failed: {m_Request.Error}"); } m_Request = null; } } }

Related information

Properties

Property Description
ErrorThe error returned by the request, if any.
IsCompletedWhether the request is complete.
StatusThe request status.