Method | Description | |
---|---|---|
AddPackageSource ( string name, string location, bool trusted, |
This is called when the user is adding (or updating) a package source If this PROVIDER doesn't support user-defined package sources, remove this method.
|
|
DownloadPackage ( string fastPackageReference, string destLocation, |
Downloads a remote package file to a local location.
|
|
FindPackage ( string name, string requiredVersion, string minimumVersion, string maximumVersion, int id, |
Searches package sources given name and version information Package information must be returned using
|
|
FindPackageByFile ( string file, int id, |
Finds packages given a locally-accessible filename Package information must be returned using
|
|
GetDynamicOptions ( string category, Request request ) : void |
Returns dynamic option definitions to the HOST example response: request.YieldDynamicOption( "MySwitch", OptionType.String.ToString(), false);
|
|
GetFeatures ( Request request ) : void |
Returns a collection of strings to the client advertizing features this provider supports.
|
|
GetInstalledPackages ( string name, string requiredVersion, string minimumVersion, string maximumVersion, |
Returns the packages that are installed. This method is called when a user type get-package, install-package and uninstall-package.
|
|
InitializeProvider ( |
Performs one-time initialization of the $provider.
|
|
InstallPackage ( string fastPackageReference, |
Installs a given package.
|
|
OnUnhandledException ( string methodName, |
This is just here as to give us some possibility of knowing when an unexception happens... At the very least, we'll write it to the system debug channel, so a developer can find it if they are looking for it.
|
|
RemovePackageSource ( string name, |
Removes/Unregisters a package source
|
|
ResolvePackageSources ( |
Resolves and returns Package Sources to the client. Specified sources are passed in via the request object (
|
|
UninstallPackage ( string fastPackageReference, |
Uninstalls a package
|
Method | Description | |
---|---|---|
IsNameMatch ( string packageName, string filePath ) : bool |
True, if the package matches.
|
|
NormalizeVersion ( |
public AddPackageSource ( string name, string location, bool trusted, |
||
name | string | The name of the package source. If this parameter is null or empty the PROVIDER should use the location as the name (if the PROVIDER actually stores names of package sources) |
location | string | The location (ie, directory, URL, etc) of the package source. If this is null or empty, the PROVIDER should use the name as the location (if valid) |
trusted | bool | A boolean indicating that the user trusts this package source. Packages returned from this source should be marked as 'trusted' |
request | An object passed in from the PackageManagement that contains functions that can be used to interact with its Provider | |
return | void |
public DownloadPackage ( string fastPackageReference, string destLocation, |
||
fastPackageReference | string | |
destLocation | string | |
request | An object passed in from the PackageManagement that contains functions that can be used to interact with its Provider | |
return | void |
public FindPackage ( string name, string requiredVersion, string minimumVersion, string maximumVersion, int id, |
||
name | string | a name or partial name of the package(s) requested |
requiredVersion | string | A specific version of the package. Null or empty if the user did not specify |
minimumVersion | string | A minimum version of the package. Null or empty if the user did not specify |
maximumVersion | string | A maximum version of the package. Null or empty if the user did not specify |
id | int | if this is greater than zero (and the number should have been generated using |
request | An object passed in from the PackageManagement that contains functions that can be used to interact with its Provider | |
return | void |
public FindPackageByFile ( string file, int id, |
||
file | string | the full path to the file to determine if it is a package |
id | int | if this is greater than zero (and the number should have been generated using |
request | An object passed in from the PackageManagement that contains functions that can be used to interact with its Provider | |
return | void |
public GetDynamicOptions ( string category, Request request ) : void | ||
category | string | The category of dynamic options that the HOST is interested in |
request | Request | An object passed in from the PackageManagement that contains functions that can be used to interact with its Provider |
return | void |
public GetFeatures ( Request request ) : void | ||
request | Request | An object passed in from the PackageManagement that contains functions that can be used to interact with its Provider |
return | void |
public GetInstalledPackages ( string name, string requiredVersion, string minimumVersion, string maximumVersion, |
||
name | string | the package name to match. Empty or null means match everything |
requiredVersion | string | the specific version asked for. If this parameter is specified (ie, not null or empty string) then the minimum and maximum values are ignored |
minimumVersion | string | the minimum version of packages to return . If the requiredVersion parameter is specified (ie, not null or empty string) this should be ignored |
maximumVersion | string | the maximum version of packages to return . If the requiredVersion parameter is specified (ie, not null or empty string) this should be ignored |
request | An object passed in from the PackageManagement that contains functions that can be used to interact with its Provider | |
return | void |
public InitializeProvider ( |
||
request | An object passed in from the CORE that contains functions that can be used to interact with the CORE and HOST | |
return | void |
public InstallPackage ( string fastPackageReference, |
||
fastPackageReference | string | A provider supplied identifier that specifies an exact package |
request | An object passed in from the PackageManagement that contains functions that can be used to interact with its Provider | |
return | void |
public OnUnhandledException ( string methodName, |
||
methodName | string | |
exception | ||
return | void |
public RemovePackageSource ( string name, |
||
name | string | The name or location of a package source to remove. |
request | An object passed in from the PackageManagement that contains functions that can be used to interact with its Provider | |
return | void |
public ResolvePackageSources ( |
||
request | An object passed in from the PackageManagement that contains functions that can be used to interact with its Provider | |
return | void |
public UninstallPackage ( string fastPackageReference, |
||
fastPackageReference | string | |
request | An object passed in from the PackageManagement that contains functions that can be used to interact with its Provider | |
return | void |