NuGetForUnity.PluginAPI

Implement this interface to add additional handling for each found installed package.

This will be called for each found installed package in the project.

The installedPackage created from found nuspec file.

Implement this interface to add additional buttons for each package in NugetForUnity window.

This method will be called for each package that is rendered in NugetForUnity window.

Package being renderer, either online package or installed package. If package is installed this represents the installed version, otherwise it is null. True if package installation should be disabled because it is already included in Unity.

Implement this interface to add additional handling of files being extracted from nupkg during installation.

This will be called when name of the folder where package will be installed should be determined.

The package whose folder name is being determined. The starting default name that can be modified or replaced. New package folder name.

This will be called for each entry that is about to be processed from nupkg that is being installed.

Package that is being installed. Zip entry that is about to be processed. The directory where the package is being installed. True if this method handled the entry and doesn't want default handling to be executed, false otherwise.

Implement this interface to add additional handling when nupkg is being uninstalled.

This method will be called for each package being uninstalled. Note that uninstall is also done for old version when package is being updated.

The package being uninstalled. The reason uninstall is being called.

This method will be called when all packages have been uninstalled using uninstall all method.

In order to register your plugin you need to implement this interface and then call methods on the provided registry object in order to provide additional functionalities for certain features.

NugetForUnity will call this method automatically so you can tell it what custom functionalities your plugin is providing.

The registry where extension points can be registered to.

NugetForUnity will pass an instance of this interface to INugetPlugin.Register method that plugins can use to register additional functionalities.

Gets a value indicating whether we are currently running in Unity or from CLI.

Gets the methods that NugetForUnity provides to the plugin, like logging methods.

Register a class that will be used to draw additional buttons for each package in NugetForUnity editor window.

The package buttons handler to register.

Register a class that will be called for each file that is extracted from the nupkg that is being installed.

The file handler to register.

Register a class that will be called when uninstalling some package.

The package uninstall handler to register.

Register a class that will be called when installed package is found.

The found installed package handler to register.

Represents a NuGet package.

Gets the title (not ID) of the package. This is the "friendly" name that only appears in GUIs and on web-pages.

Gets the URL for the location of the package's source code.

Gets the list of dependencies for the framework that best matches what is available in Unity.

List of dependencies.

Interface for a versioned NuGet package.

Gets the Id of the package.

Gets or sets the normalized version number of the NuGet package. This is the normalized version number without build-metadata e.g. 1.0.0+b3a8 is normalized to 1.0.0.

Returns the folder path where this package is or will be installed.

In case you need to manipulate the folder to a bit different name you can provide the prefix you want to add to folder name here. Folder path where this package is or will be installed with an optional prefix to final path segment.

Service methods that NugetForUnity provides to its plugins.

Gets the absolute path to the projects Assets directory.

Gets the absolute path to the directory where packages are installed.

Allows plugin to register a function that will modify the contents of default new nuspec file.

The function that will receive default nuspec file and modify it.

Allows plugin to create a new nuspec file on the given location.

Either the absolute path within project to an existing directory or path relative to project's Asset folder.

Logs the given error message.

Message to log.

Logs a formatted error message.

A composite format string. Format arguments.

Logs a formatted error message only if Verbose logging is enabled.

A composite format string. Format arguments.

Represents a .nuspec file used to store metadata for a NuGet package.

Gets or sets the Id of the package.

Gets or sets the source control branch the package is from.

Gets or sets the source control commit the package is from.

Gets or sets the type of source control software that the package's source code resides in.

Gets or sets the url for the location of the package's source code.

Gets or sets the title of the NuGet package.

Gets or sets the owners of the NuGet package.

Gets or sets the URL for the location of the license of the NuGet package.

Gets or sets the URL for the location of the project web-page of the NuGet package.

Gets or sets the URL for the location of the icon of the NuGet package.

Gets the path to a icon file. The path is relative to the root folder of the package. This is a alternative to using a URL .

Gets the full path to a icon file. This is only set if the .nuspec file contains a . This is a alternative to using a URL .

Gets or sets a value indicating whether the license of the NuGet package needs to be accepted in order to use it.

Gets or sets the release notes of the NuGet package.

Gets or sets the copyright of the NuGet package.

Gets or sets the tags of the NuGet package.

Gets or sets the description of the NuGet package.

Gets or sets the description of the NuGet package.

Gets or sets the authors of the NuGet package.

Tells the uninstall method what kind of request from the user initiated it.

User has requested individual packages to be uninstalled from the project.

User has requested all packages to be uninstalled from the project.

Use requested individual packages to be updated.

Use requested all packages to be updated.