TeamCityInfo Class

Summary

Base class used to provide information about the TeamCity environment.
Namespace
Cake.Common.Build.TeamCity
Base Types
  • object
Derived Types
graph BT Type-->Base0["object"] Type["TeamCityInfo"] class Type type-node Derived0["TeamCityBuildInfo"]-->Type click Derived0 "/api/Cake.Common.Build.TeamCity.Data/TeamCityBuildInfo" Derived1["TeamCityProjectInfo"]-->Type click Derived1 "/api/Cake.Common.Build.TeamCity.Data/TeamCityProjectInfo" Derived2["TeamCityPullRequestInfo"]-->Type click Derived2 "/api/Cake.Common.Build.TeamCity.Data/TeamCityPullRequestInfo" Derived3["TeamCityEnvironmentInfo"]-->Type click Derived3 "/api/Cake.Common.Build.TeamCity.Data/TeamCityEnvironmentInfo"

Syntax

public abstract class TeamCityInfo

Constructors

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

Methods

Name Value Summary
GetEnvironmentBoolean(string) bool
Gets an environment variable as a bool.
GetEnvironmentInteger(string) int
Gets an environment variable as a int.
GetEnvironmentString(string) string
Gets an environment variable as a string.

Extension Methods

Name Value Summary
Dump<TeamCityInfo>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<TeamCityInfo>(TeamCityInfo[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<TeamCityInfo>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<TeamCityInfo>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<TeamCityInfo>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<TeamCityInfo>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
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