Client
Use the Unity Package Manager Client class to manage the packages used in a project.
Read time 2 minutesLast updated 5 days ago
Definition
- Type: Class
- Namespace: UnityEditor.PackageManager
- Assembly: UnityEditor.CoreModule
public static class Client
Remarks
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 Client.Remove method on a package while a operation is already in progress or queued, your call might overwrite the current operation and handle only the latest operation.
RemoveRemoveusing 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
Property | Description |
|---|---|
| LogLevel | Gets or sets the log level that the Package Manager uses when logging to the |
Static Methods
Method | Description |
|---|---|
| Add | Adds 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. |
| AddAndRemove | Adds 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. |
| ClearCache | Empties the package cache. |
| Embed | Embeds a package inside the project. |
| List | Lists the packages the project depends on. |
| Pack | Creates 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. |
| Remove | Removes 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. |
| Resolve | Forces the Package Manager to resolve the project's packages, reinstalling any altered or missing package and removing extraneous packages. |
| Search | Searches for packages in the Unity Package Registry. Returns a SearchRequest object that provides access to matching packages. |
| SearchAll | Searches for all discoverable packages compatible with the current Unity version. |