Client Class

Summary

This class encapsulates the Mercurial client application.
Assembly
Mercurial.Net.dll
Namespace
Mercurial
Base Types
  • object
graph TD Base0["object"]-->Type Type["Client"] class Type type-node

Syntax

public static class Client

Properties

Name Value Summary
ClientPath string
Gets the path to the Mercurial client executable.
static
Configuration ClientConfigurationCollection
Gets the current client configuration.
static
CouldLocateClient bool
Gets a value indicating whether the Mercurial client executable could be located or not.
static
CurrentVersion Version
Gets the version of the Mercurial client installed and in use, that was detected during startup of the Mercurial.Net library, or overriden through the use of SetClientPath(string).
static
SupportedVersions IEnumerable<T>
Gets a collection of supported versions of the Mercurial client.
static

Methods

Name Value Summary
Execute(IMercurialCommand) void
Executes the given IMercurialCommand command without a repository.
static
Execute(string, IMercurialCommand) void
Executes the given IMercurialCommand command against the Mercurial repository.
static
GetVersion() Version
Gets the version of the Mercurial client installed and in use. Note that System.Version.Revision and System.Version.Build can be 0 for major and minor versions of Mercurial.
static
RemoteInit(RemoteInitCommand) void
Initializes a repository remotely, through a server which supports such functionality.
static
RemoteInit(string, RemoteInitCommand) void
Initializes a repository remotely, through a server which supports such functionality.
static
SetClientPath(string) void
Assigns a specific client path to the Mercurial.Net library, allowing the program that uses the library to select the applicable Mercurial version to use, or even to come bundled with its own Mercurial client files.
static