IAppVeyorApi Interface

Summary

Provides the API methods that can be called against AppVeyor via the AppVeyorClient.
Assembly
Cake.AppVeyor.dll
Namespace
Cake.AppVeyor
graph BT Type["IAppVeyorApi"] class Type type-node

Syntax

public interface IAppVeyorApi

Methods

Name Value Summary
CancelBuild(string, string, string) Task
Cancels a build.
CancelDeployment(AppVeyorCancelDeploymentRequest) Task
Cancels a deployment.
ClearCache(string, string) Task
Clear the cache for a given AppVeyor project.
GetDeployment(int) Task<AppVeyorProjectDeployment>
Gets a single deployment.
GetEnvironmentDeployments(int) Task<AppVeyorEnvironmentDeployments>
Gets all deployments for a given environment.
GetEnvironments() Task<List<AppVeyorEnvironment>>
Gets all environemnts.
GetProjectBuildByVersion(string, string, string) Task<AppVeyorProjectBuild>
Gets a specific AppVeyor build based on buil version number.
GetProjectDeployments(string, string) Task<AppVeyorProjectDeployments>
Get the deployments for a given project.
GetProjectHistory(string, string, int, Nullable<int>, string) Task<AppVeyorProjectHistory>
Gets the history for a given project from AppVeyor.
GetProjectLastBranchBuild(string, string, string) Task<AppVeyorProjectBuild>
Gets the latest build for a given project based on branch name.
GetProjectLastBuild(string, string) Task<AppVeyorProjectBuild>
Gets the latest build for a given project.
GetProjects() Task<List<AppVeyorProject>>
Gets a list of projects from AppVeyor.
StartBuildLatestCommit(AppVeyorBuildRequestLatestCommit) Task<AppVeyorBuild>
Starts a build.
StartBuildPullRequest(AppVeyorBuildRequestPullRequest) Task<AppVeyorBuild>
Starts a build from a pull request.
StartBuildSpecificCommit(AppVeyorBuildRequestSpecificCommit) Task<AppVeyorBuild>
Starts a build for a given commit.
StartDeployment(AppVeyorStartDeploymentRequest) Task<AppVeyorDeployment>
Starts a deployment.

Extension Methods

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