This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.ProGet.

Summary

Contains settings used for the UniversalPackageInstaller command.

Assembly

Cake.ProGet.dll

Namespace

Cake.ProGet.Universal.Install

Base Types

graph BT Type-->Base0["ToolSettings"] Type["UniversalPackageInstallSettings"] class Type type-node

Syntax

public sealed class UniversalPackageInstallSettings : ToolSettings

Name	Summary
UniversalPackageInstallSettings()	Initializes a new instance of the `UniversalPackageInstallSettings` class.
UniversalPackageInstallSettings(string, string, DirectoryPath)	Initializes a new instance of the `UniversalPackageInstallSettings` class.

Name	Value	Summary
Overwrite	bool	Gets or sets a value indicating whether the package should be overwritten if it already exists.
Package	string	Gets or sets the package to install
Password	string	Gets or sets the password for an authenticated endpoint
PreserveTimestamps	bool	Gets or sets a value indicating whether timestamps of installed files should be preserved as in the package.
Source	string	Gets or sets the URL of a upack API endpoint to install from.
TargetDirectory	DirectoryPath	Gets or sets the target directory to install the package
UserName	string	Gets or sets the username for an authenticated endpoint
Version	string	Gets or sets the version to install. If version is not specified, the latest will be retrieved.

Name	Value	Summary
AreCredentialsValid()	bool	Gets whether or not both username and password are specified
HasCredentials()	bool	Gets whether or not credentials are specified
HasVersion()	bool	Determines whether this instance has a version specified.

Name	Value	Summary
Dump<UniversalPackageInstallSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<UniversalPackageInstallSettings>(UniversalPackageInstallSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<UniversalPackageInstallSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
NotNull<UniversalPackageInstallSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
ThrowIfNull<UniversalPackageInstallSettings>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<UniversalPackageInstallSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin