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.Tfx.
Summary
Contains the common server settings used by some commands in Tfx.
- Assembly
- Cake
.Tfx .dll - Namespace
- Cake
.Tfx - Base Types
-
- ToolSettings
- TfxSettings
- Derived Types
graph BT
Type-->Base0["TfxSettings"]
click Base0 "/api/Cake.Tfx/TfxSettings"
Base0-->Base1["ToolSettings"]
Type["TfxServerSettings"]
class Type type-node
Derived0["TfxExtensionPublishSettings"]-->Type
click Derived0 "/api/Cake.Tfx.Extension.Publish/TfxExtensionPublishSettings"
Derived1["TfxExtensionShareSettings"]-->Type
click Derived1 "/api/Cake.Tfx.Extension.Share/TfxExtensionShareSettings"
Derived2["TfxExtensionInstallSettings"]-->Type
click Derived2 "/api/Cake.Tfx.Extension.Install/TfxExtensionInstallSettings"
Syntax
public abstract class TfxServerSettings : TfxSettingsConstructors
| Name | Summary |
|---|---|
| TfxServerSettings |
Properties
| Name | Value | Summary |
|---|---|---|
| AuthType | TfxAuthType |
Gets or sets the method of authentication.
|
| ExtensionId | string |
Gets or sets a value to use as the extension ID instead of what is specified in the manifest.
Inherited from TfxSettings
|
| 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 |
Gets or sets a value indicating the output type to be used for commands
Inherited from TfxSettings
|
| Password | string |
Gets or sets the Password to use for basic authentication.
|
| Proxy | string |
Gets or sets the proxy server for HTTP traffic
|
| Publisher | string |
Gets or sets a value to use as the publisher ID instead of what is specified in the manifest.
Inherited from TfxSettings
|
| 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
|
| Token | string |
Gets or sets the Personal Access Token.
|
| UserName | string |
Gets or sets the Username to use for basic authentication.
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| ThrowIfNull |
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 |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|