Client

class in UnityEditor.PackageManager

Switch to Manual

Description

Use the Unity Package Manager Client class to manage the packages used in a project.

Note: You can call the Client methods only in sequence. If you try to add or remove multiple packages at the same time, the outcome is nondeterministic. For example, if you call the Remove method on a package while a Remove operation is already in progress or queued, your call might overwrite the current operation and handle only the latest Remove operation.

using UnityEngine;
using UnityEditor.PackageManager;
using UnityEditor.PackageManager.Requests;
[ExecuteInEditMode]
public class PackageManagerClientExample : MonoBehaviour
{
    ListRequest m_ListRequest;
    
    void Start()
    {
        Debug.Log("Listing packages with package manager client...");
        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;
        }
    }
}

Related information

Static Properties

LogLevelGets or sets the log level that the Package Manager uses when logging to the Editor.log and upm.log files. Defaults to LogLevel.Info.

Static Methods

AddAdds a package dependency to the project. Requesting a new or different dependency often leads to changing installed packages, but only after the Package Manager constructs a dependency graph to solve any version conflicts.
AddAndRemoveAdds package dependencies to the project and removes package dependencies from the project. Requesting different dependencies often leads to changing installed packages, but only after the Package Manager constructs a dependency graph to solve any version conflicts. For more information, see Dependency and resolution. Calling this function is much more efficient than calling the Add and Remove functions several times because for this function, the Package Manager only has to solve the dependency list once, instead of constructing a new dependency graph after each call.
ClearCacheEmpties the package cache.
Embed Embeds a package inside the project.
ListLists the packages the project depends on.
PackCreates a GZip tarball file from a package folder. The format and content of the file is the same as if the package was published to a package registry.
RemoveRemoves a package dependency from the project. Removing a dependency often leads to changing installed packages, but only after the Package Manager constructs a dependency graph to solve any version conflicts. For more information, see Dependency and resolution.
ResolveForces the Package Manager to resolve the project's packages, reinstalling any altered or missing package and removing extraneous packages.
SearchSearches for the given package.
SearchAllSearches for all discoverable packages compatible with the current Unity version.

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