BitriseInfo Class

Summary

Base class used to provide information about the Bamboo environment.
Namespace
Cake.Common.Build.Bitrise
Base Types
  • object
Derived Types
graph BT Type-->Base0["object"] Type["BitriseInfo"] class Type type-node Derived0["BitriseApplicationInfo"]-->Type click Derived0 "/api/Cake.Common.Build.Bitrise.Data/BitriseApplicationInfo" Derived1["BitriseRepositoryInfo"]-->Type click Derived1 "/api/Cake.Common.Build.Bitrise.Data/BitriseRepositoryInfo" Derived2["BitriseBuildInfo"]-->Type click Derived2 "/api/Cake.Common.Build.Bitrise.Data/BitriseBuildInfo" Derived3["BitriseProvisioningInfo"]-->Type click Derived3 "/api/Cake.Common.Build.Bitrise.Data/BitriseProvisioningInfo" Derived4["BitriseDirectoryInfo"]-->Type click Derived4 "/api/Cake.Common.Build.Bitrise.Data/BitriseDirectoryInfo" Derived5["BitriseEnvironmentInfo"]-->Type click Derived5 "/api/Cake.Common.Build.Bitrise.Data/BitriseEnvironmentInfo" Derived6["BitriseWorkflowInfo"]-->Type click Derived6 "/api/Cake.Common.Build.Bitrise.Data/BitriseWorkflowInfo" Derived7["BitrisePullRequestInfo"]-->Type click Derived7 "/api/Cake.Common.Build.Bitrise.Data/BitrisePullRequestInfo"

Syntax

public abstract class BitriseInfo

Constructors

Name Summary
BitriseInfo(ICakeEnvironment) Initializes a new instance of the BitriseInfo 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<BitriseInfo>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<BitriseInfo>(BitriseInfo[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<BitriseInfo>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<BitriseInfo>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<BitriseInfo>(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<BitriseInfo>(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