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.Topshelf.

Summary

Topshelf installer settings

Assembly

Cake.Topshelf.dll

Namespace

Cake.Topshelf

Base Types

Object

graph BT Type-->Base0["Object"] Type["TopshelfSettings"] class Type type-node

Syntax

public class TopshelfSettings

Constructors

Name	Summary
TopshelfSettings()	Initializes a new instance of the `TopshelfSettings` class.

Properties

Name	Value	Summary
Arguments	ProcessArgumentBuilder	Sets the arguments to use during installation
Autostart	bool	Gets or sets if the service should automatically start when windows loads
Delayed	bool	Gets or sets if the service should start automatically (delayed)
Description	string	Gets or sets the service description the service should use when installing
Disabled	bool	Gets or sets if the service should be set to disabled
DisplayName	string	Gets or sets the display name the the service should use when installing
Instance	string	Gets or sets the instance name if registering the service multiple times
LocalService	bool	Gets or sets the service with run with the local service account
LocalSystem	bool	Gets or sets the service with run with the local system account
NetworkService	bool	Gets or sets the service with run with the network service account
Password	string	Gets or sets the password for the specified username.
ServiceName	string	Gets or sets the name that the service should use when installing
Timeout	int	Gets or sets the time in milliseconds to wait for the Topshelf executable to install
Username	string	Gets or sets the username to run the service.

Extension Methods

Name	Value	Summary
Dump<TopshelfSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<TopshelfSettings>(TopshelfSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<TopshelfSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<TopshelfSettings>(string)	void	From IssuesArgumentChecks Requires the Cake.Issues addin
SetAutostart(bool)	TopshelfSettings	Sets if the service should automatically start when windows loads From TopshelfSettingsExtensions Requires the Cake.Topshelf addin
SetDelayed(bool)	TopshelfSettings	Sets if the service should start automatically (delayed) From TopshelfSettingsExtensions Requires the Cake.Topshelf addin
SetDescription(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. From TopshelfSettingsExtensions Requires the Cake.Topshelf addin
SetDisabled(bool)	TopshelfSettings	Sets if the service should be set to disabled From TopshelfSettingsExtensions Requires the Cake.Topshelf addin
SetDisplayName(string)	TopshelfSettings	Specifies a friendly name that can be used by user interface programs to identify the service. From TopshelfSettingsExtensions Requires the Cake.Topshelf addin
SetInstance(string)	TopshelfSettings	Sets the instance name if registering the service multiple times From TopshelfSettingsExtensions Requires the Cake.Topshelf addin
SetServiceName(int)	TopshelfSettings	Specifies the time in milliseconds to wait for the Topshelf executable From TopshelfSettingsExtensions Requires the Cake.Topshelf addin
SetServiceName(string)	TopshelfSettings	Specifies the service name returned by the getkeyname operation. From TopshelfSettingsExtensions Requires the Cake.Topshelf addin
ThrowIfNull<TopshelfSettings>(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<TopshelfSettings>(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	From StringExtensions Requires the Cake.Issues addin
UseLocalService(bool)	TopshelfSettings	Sets if the service with run with the local service account From TopshelfSettingsExtensions Requires the Cake.Topshelf addin
UseLocalSystem(bool)	TopshelfSettings	Sets if the service with run with the local system account From TopshelfSettingsExtensions Requires the Cake.Topshelf addin
UseNetworkService(bool)	TopshelfSettings	Sets if the service with run with the network service account From TopshelfSettingsExtensions Requires the Cake.Topshelf addin
UsePassword(string)	TopshelfSettings	Sets the credentials to use when connecting From TopshelfSettingsExtensions Requires the Cake.Topshelf addin
UseUsername(string)	TopshelfSettings	Sets the credentials to use when connecting From TopshelfSettingsExtensions Requires the Cake.Topshelf addin
WithArguments(Action<ProcessArgumentBuilder>)	TopshelfSettings	Sets the arguments to use during installation From TopshelfSettingsExtensions Requires the Cake.Topshelf addin

TopshelfSettings Class

Summary

Syntax

Constructors

Properties

Extension Methods