TFInfo Class

Summary

Base class used to provide information about the TF Build environment.
graph BT Type-->Base0["object"] Type["TFInfo"] class Type type-node Derived0["TFBuildDefinitionInfo"]-->Type click Derived0 "/api/Cake.Common.Build.TFBuild.Data/TFBuildDefinitionInfo" Derived1["TFBuildEnvironmentInfo"]-->Type click Derived1 "/api/Cake.Common.Build.TFBuild.Data/TFBuildEnvironmentInfo" Derived2["TFBuildTriggeredBy"]-->Type click Derived2 "/api/Cake.Common.Build.TFBuild.Data/TFBuildTriggeredBy" Derived3["TFBuildRepositoryInfo"]-->Type click Derived3 "/api/Cake.Common.Build.TFBuild.Data/TFBuildRepositoryInfo" Derived4["TFBuildInfo"]-->Type click Derived4 "/api/Cake.Common.Build.TFBuild.Data/TFBuildInfo" Derived5["TFBuildPullRequestInfo"]-->Type click Derived5 "/api/Cake.Common.Build.TFBuild.Data/TFBuildPullRequestInfo" Derived6["TFBuildTeamProjectInfo"]-->Type click Derived6 "/api/Cake.Common.Build.TFBuild.Data/TFBuildTeamProjectInfo" Derived7["TFBuildAgentInfo"]-->Type click Derived7 "/api/Cake.Common.Build.TFBuild.Data/TFBuildAgentInfo"

Syntax

public abstract class TFInfo

Constructors

Name Summary
TFInfo(ICakeEnvironment) Initializes a new instance of the TFInfo 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.
GetEnvironmentUri(string) Uri
Gets an environment variable as a System.Uri.
GetRepositoryType(string) TFRepositoryType?
Gets the current repository type as a TFRepositoryType from an environment variable.

Extension Methods

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