Summary

Provides RWX run information for the current build.

Namespace

Cake.Common.Build.Rwx.Data

Base Types

graph BT Type-->Base0["RwxInfo"] click Base0 "/api/Cake.Common.Build.Rwx/RwxInfo" Base0-->Base1["object"] Type["RwxRunInfo"] class Type type-node

Syntax

public sealed class RwxRunInfo : RwxInfo

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

Name	Value	Summary
Id	string	Gets the RWX identifier of the current run.
Title	string	Gets the title of the current RWX run.
Url	string	Gets the link to the current run in RWX.

Name	Value	Summary
GetEnvironmentBoolean(string)	bool	Gets an environment variable as a `bool`. Inherited from RwxInfo
GetEnvironmentDirectoryPath(string)	DirectoryPath	Gets an environment variable as a `DirectoryPath`. Inherited from RwxInfo
GetEnvironmentInteger(string)	int	Gets an environment variable as a `int`. Inherited from RwxInfo
GetEnvironmentString(string)	string	Gets an environment variable as a `string`. Inherited from RwxInfo

Name	Value	Summary
Dump<RwxRunInfo>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<RwxRunInfo>(RwxRunInfo[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<RwxRunInfo>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<RwxRunInfo>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<RwxRunInfo>(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<RwxRunInfo>(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	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin