TopshelfSettingsExtensions Class

Summary

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

Syntax

public static class TopshelfSettingsExtensions

Methods

Name Value Summary
SetAutostart(TopshelfSettings, bool) TopshelfSettings
Sets if the service should automatically start when windows loads
static
SetDelayed(TopshelfSettings, bool) TopshelfSettings
Sets if the service should start automatically (delayed)
static
SetDescription(TopshelfSettings, string) TopshelfSettings
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
SetDisabled(TopshelfSettings, bool) TopshelfSettings
Sets if the service should be set to disabled
static
SetDisplayName(TopshelfSettings, string) TopshelfSettings
Specifies a friendly name that can be used by user interface programs to identify the service.
static
SetInstance(TopshelfSettings, string) TopshelfSettings
Sets the instance name if registering the service multiple times
static
SetServiceName(TopshelfSettings, int) TopshelfSettings
Specifies the time in milliseconds to wait for the Topshelf executable
static
SetServiceName(TopshelfSettings, string) TopshelfSettings
Specifies the service name returned by the getkeyname operation.
static
UseLocalService(TopshelfSettings, bool) TopshelfSettings
Sets if the service with run with the local service account
static
UseLocalSystem(TopshelfSettings, bool) TopshelfSettings
Sets if the service with run with the local system account
static
UseNetworkService(TopshelfSettings, bool) TopshelfSettings
Sets if the service with run with the network service account
static
UsePassword(TopshelfSettings, string) TopshelfSettings
Sets the credentials to use when connecting
static
UseUsername(TopshelfSettings, string) TopshelfSettings
Sets the credentials to use when connecting
static
WithArguments(TopshelfSettings, Action<ProcessArgumentBuilder>) TopshelfSettings
Sets the arguments to use during installation
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin