TfxExtensionPublishSettings Class

Summary

Contains settings used by TfxExtensionPublishRunner.
Assembly
Cake.Tfx.dll
Namespace
Cake.Tfx.Extension.Publish
Interfaces
Base Types
graph BT Type-->Base0["TfxServerSettings"] click Base0 "/api/Cake.Tfx/TfxServerSettings" Base0-->Base1["TfxSettings"] click Base1 "/api/Cake.Tfx/TfxSettings" Base1-->Base2["ToolSettings"] Type-.->Interface0["ICreatePublishSettings"] click Interface0 "/api/Cake.Tfx.Extension/ICreatePublishSettings" Type["TfxExtensionPublishSettings"] class Type type-node

Syntax

public sealed class TfxExtensionPublishSettings : TfxServerSettings, ICreatePublishSettings

Constructors

Name Summary
TfxExtensionPublishSettings()

Properties

Name Value Summary
AuthType TfxAuthType
Gets or sets the method of authentication.
Inherited from TfxServerSettings
BypassValidation bool
Gets or sets a value indicating whether to bypass local validation.
ExtensionId string
Gets or sets a value to use as the extension ID instead of what is specified in the manifest.
Inherited from TfxSettings
LocRoot string
Gets or sets the Root of localization hierarchy
ManifestGlobs ICollection<string>
Gets or sets the List of globs to find manifests.
NoPrompt bool
Gets or sets a value indicating whether to not prompt the user for input (instead, raise an error).
Inherited from TfxSettings
Output Nullable<TfxOutputType>
Gets or sets a value indicating the output type to be used for commands
Inherited from TfxSettings
OutputPath DirectoryPath
Gets or sets the Path to write the VSIX.
Override string
Gets or sets the JSON string which is merged into the manifests, overriding any values.
OverridesFile FilePath
Gets or sets the path to a JSON file with overrides. This partial manifest will always take precedence over any values in the manifests.
Password string
Gets or sets the Password to use for basic authentication.
Inherited from TfxServerSettings
Proxy string
Gets or sets the proxy server for HTTP traffic
Inherited from TfxServerSettings
Publisher string
Gets or sets a value to use as the publisher ID instead of what is specified in the manifest.
Inherited from TfxSettings
Root DirectoryPath
Gets or sets the Root directory to be used when creating extension.
Save bool
Gets or sets a value indicating whether to save arguments for the next time a command in this command group is run.
Inherited from TfxSettings
ServiceUrl string
Gets or sets the URL to the VSS Marketplace
Inherited from TfxServerSettings
ShareWith ICollection<string>
Gets or sets List of VSTS Accounts with which to share the extension.
Token string
Gets or sets the Personal Access Token.
Inherited from TfxServerSettings
UserName string
Gets or sets the Username to use for basic authentication.
Inherited from TfxServerSettings

Extension Methods

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