ListRequest

class in UnityEditor.PackageManager.Requests

/

Inherits from:PackageManager.Requests.Request_1

Switch to Manual

Description

Represents an asynchronous request to list the packages in the project.

The PackageManager Client class returns a ListRequest instance when you call the Client.List method to list the package dependencies of your project. Use this object to determine when the request is complete and to access the result.

After the request completes, you can retrieve the PackageCollection instance from the Result property.

using UnityEngine;
using UnityEditor.PackageManager;
using UnityEditor.PackageManager.Requests;
[ExecuteInEditMode]
public class ListRequestExample : MonoBehaviour
{
    ListRequest m_ListRequest;
    
    void Start()
    {
        Debug.Log("Listing packages...");
        m_ListRequest = Client.List();
    }
    void Update()
    {
        if (m_ListRequest != null && m_ListRequest.IsCompleted)
        {
            if (m_ListRequest.Status == StatusCode.Success)
            {
                foreach (var package in m_ListRequest.Result)
                {
                    Debug.Log($"{package.name}");
                }
            }
            else
            {
                Debug.Log($"Package list request failed: {m_ListRequest.Error}");
            }
            m_ListRequest = null;
        }
    }
}

Inherited Members

Properties

ErrorThe error returned by the request, if any.
IsCompletedWhether the request is complete.
StatusThe request status.
ResultA property that provides access to the result of a completed Package Manager request operation.

Did you find this page useful? Please give it a rating: