SearchRequest
Represents an asynchronous request to find a package.
Read time 1 minuteLast updated 10 days ago
Definition
- Type: Class
- Namespace: UnityEditor.PackageManager.Requests
- Assembly: UnityEditor.CoreModule
- Inherits from: Request<PackageInfo[]>
- Implements: ISerializationCallbackReceiver
public sealed class SearchRequest : Request<PackageInfo[]>, ISerializationCallbackReceiver
Remarks
The PackageManager Client class returns a SearchRequest instance when you call the Client.Search method to find a package or the Client.SearchAll method to find all discoverable packages. Use this object to determine when the request is complete and to access the result.
After the request completes, you can retrieve the array of PackageInfo instances from the Result property.
using UnityEngine;using UnityEditor.PackageManager;using UnityEditor.PackageManager.Requests;[ExecuteInEditMode]public class PackageManagerSearchExample : MonoBehaviour{ SearchRequest m_SearchRequest; void Start() { Debug.Log("SearchRequest example..."); m_SearchRequest = Client.Search("com.unity.textmeshpro"); } void Update() { if (m_SearchRequest != null && m_SearchRequest.IsCompleted) { if (m_SearchRequest.Status == StatusCode.Success) { var packages = m_SearchRequest.Result; if (packages.Length > 0) { var package = packages[0]; Debug.Log($"Found package: {package.name}" + $"\nVersion: {package.version}" + $"\nDescription: {package.description}"); } else { Debug.Log("No packages found"); } } else { Debug.LogError($"Search failed: {m_SearchRequest.Error.message}"); } m_SearchRequest = null; } }}
Related information
Properties
Property | Description |
|---|---|
| PackageIdOrName | The package id or name used in this search operation. |