AppVeyorEnvironmentInfo Class

Summary

Provides AppVeyor environment information for a current build.
Namespace
Cake.Common.Build.AppVeyor.Data
Base Types
graph BT Type-->Base0["AppVeyorInfo"] click Base0 "/api/Cake.Common.Build.AppVeyor/AppVeyorInfo" Base0-->Base1["object"] Type["AppVeyorEnvironmentInfo"] class Type type-node

Syntax

public sealed class AppVeyorEnvironmentInfo : AppVeyorInfo

Constructors

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

Properties

Name Value Summary
ApiUrl string
Gets the AppVeyor build agent API URL.
Build AppVeyorBuildInfo
Gets AppVeyor build information.
Configuration string
Gets the configuration name set on build tab of project settings (or through configuration parameter in appveyor.yml).
JobId string
Gets the AppVeyor unique job ID.
JobName string
Gets the AppVeyor Job Name.
Platform string
Gets the platform name set on build tab of project settings (or through platform parameter in appveyor.yml).
Project AppVeyorProjectInfo
Gets AppVeyor project information.
PullRequest AppVeyorPullRequestInfo
Gets AppVeyor pull request information.
Repository AppVeyorRepositoryInfo
Gets AppVeyor repository information.
ScheduledBuild bool
Gets a value indicating whether the build runs by scheduler.

Methods

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

Extension Methods

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