BuildMaster SDK Reference

Version:

ProviderBase Class

Base class for all providers.

Inheritance Hierarchy

object
- Inedo.BuildMaster.Extensibility.Providers.ProviderBase
  - Inedo.BuildMaster.Extensibility.Providers.SourceControl.SourceControlProviderBase
  - Inedo.BuildMaster.Extensibility.Providers.IssueTracking.IssueTrackingProviderBase

Syntax

public class ProviderBase : System.IDisposable, Inedo.Diagnostics.ILogger

Constructors

	Name	Description
	ProviderBase	Initializes a new instance of the ProviderBase class.

Events

	Name	Description
	LogReceived	Raised when a log message has been received.

Properties

	Name	Description
	Agent	Gets the agent responsible for executing this Provider's commands.
	LogCommandLineArguments	Indicates whether the ExecuteCommandLine(string fileName, string arguments, string workingDirectory) method should log the command name and arguments.

Methods

	Name	Description
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
	Dispose(bool disposing)	Releases unmanaged and - optionally - managed resources.
	ExecuteCommandLine(string fileName, string arguments, string workingDirectory)	Executes a command line process on the provider's agent.
	ExecuteCommandLine(Inedo.Agents.RemoteProcessStartInfo startInfo)	Executes a command line process on the provider's agent.
	IsAvailable	When implemented in a derived class, indicates whether the provider is installed and available for use in the current execution context.
	LogDebug(string message)	Logs the specified message to the Provider's log with a Debug log level.
	LogDebug(string messageFmt, object[] args)	Logs the specified message to the Provider's log with a Debug log level.
	LogError(string message)	Logs the specified message to the Provider's log with an Error log level.
	LogError(string messageFmt, object[] args)	Logs the specified message to the Provider's log with an Error log level.
	LogInformation(string message)	Logs the specified message to the Provider's log with an Information log level.
	LogInformation(string messageFmt, object[] args)	Logs the specified message to the Provider's log with an Information log level.
	LogWarning(string message)	Logs the specified message to the Provider's log with a Warning log level.
	LogWarning(string messageFmt, object[] args)	Logs the specified message to the Provider's log with a Warning log level.
	SetAgent(Inedo.Extensibility.Agents.Agent agent, bool disposeAgent)	Inititializes the Agent property.
	ThrowIfTimeoutExpired	Throws a Inedo.BuildMaster.Extensibility.Actions.ActionTimeoutException if the action has been executing for at least Timeout seconds.
	ToString	Returns a System.String that represents this instance.
	ValidateConnection	When implemented in a derived class, attempts to connect with the current configuration and throws an exception if unsuccessful.

Remarks

This class should not normally be inherited directly in an extension.