class MAGES::Editor::PackageManagerUtility¶

Overview¶

Functions for Installing/Deleting/Checking packages while in Editor. More…

class PackageManagerUtility
{
public:
    // methods

    PackageManagerUtility();
    void ListPackages(Action onListFinished);
    void ListPackages(bool offlineMode, Action onListFinished);

    void ListPackages(
        bool offlineMode,
        bool includeIndirectDependencies,
        Action onListFinished
    );

    void InstallPackage(
        string packageName,
        Action onInstallationFinished
    );

    void SearchPackage(
        string packageNameOrId,
        Action onSearchFinished,
        bool offlineMode = true
    );
};

Detailed Documentation¶

Functions for Installing/Deleting/Checking packages while in Editor.

Methods¶

PackageManagerUtility()

Initializes a new instance of the PackageManagerUtility class.

void ListPackages(Action onListFinished)

Lists the packages the project depends on. Computes and returns the set of all packages that the project depends on(the resolved dependency graph) without physically downloading or installing any packages.The operation result contains only the resolved dependency graph as a PackageCollection.

Parameters:

onListFinished
onListFinished arg1	The action to call when the request finishes.

void ListPackages(bool offlineMode, Action onListFinished)

Parameters:

offlineMode	Specifies whether or not the Package Manager requests the latest information about the project’s packages from the remote Unity package registry. When offlineMode is true, the PackageInfo object returned by the Package Manager contains information obtained from the local package cache, which could be out of date.
onListFinished
onListFinished arg1	The action to call when the request finishes.

void ListPackages(
    bool offlineMode,
    bool includeIndirectDependencies,
    Action onListFinished
)

Parameters:

offlineMode	Specifies whether or not the Package Manager requests the latest information about the project’s packages from the remote Unity package registry. When offlineMode is true, the PackageInfo object returned by the Package Manager contains information obtained from the local package cache, which could be out of date.
includeIndirectDependencies	Specifies whether or not the Package Manager includes indirect dependencies in the list of packages returned by the operation.
onListFinished
onListFinished arg1	The action to call when the request finishes.

void InstallPackage(
    string packageName,
    Action onInstallationFinished
)

Installs a package.

Parameters:

packageName	The name of the package to install.
onInstallationFinished
onInstallationFinished arg1	The package name.
onInstallationFinished arg2	Action to be called when the installation is finished.

void SearchPackage(
    string packageNameOrId,
    Action onSearchFinished,
    bool offlineMode = true
)

Searches the package manager for a package.

Parameters:

packageNameOrId	The package name or id.
onSearchFinished
onSearchFinished arg1	The package name or id.
onSearchFinished arg2	The action to call when the search finishes.
offlineMode	Specifies whether or not the Package Manager requests the latest information about the project’s packages from the remote Unity package registry. When offlineMode is true, the PackageInfo object returned by the Package Manager contains information obtained from the local package cache, which could be out of date.