InstallSettingsExtensions Class

Summary

Contains extension methods for InstallSettings.
Assembly
Cake.Services.dll
Namespace
Cake.Services
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["InstallSettingsExtensions"] class Type type-node

Syntax

public static class InstallSettingsExtensions

Methods

Name Value Summary
SetDependencies(InstallSettings, string) InstallSettings
Specifies the names of services or groups that must start before this service starts. The names are separated by forward slashes (/).
static
SetDescription(InstallSettings, string) InstallSettings
Specifies a description for the specified service. If no string is specified, the description of the service is not modified. There is no limit to the number of characters in the service description.
static
SetDisplayName(InstallSettings, string) InstallSettings
Specifies a friendly name that can be used by user interface programs to identify the service.
static
SetExecutablePath(InstallSettings, FilePath) InstallSettings
Specifies a path to the service binary file.
static
SetServiceName(InstallSettings, string) InstallSettings
Specifies the service name returned by the getkeyname operation.
static
SetStartMode(InstallSettings, string) InstallSettings
Specifies the start type for the service. The default setting is start= demand.
static
UsePassword(InstallSettings, string) InstallSettings
Gets or sets the credentials to use when connecting
static
UseUsername(InstallSettings, string) InstallSettings
Gets or sets the credentials to use when connecting
static
WithArguments(InstallSettings, Action<ProcessArgumentBuilder>) InstallSettings
Sets the arguments to use during installation
static

Extension Methods

Name Value Summary
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