Summary

This class implements the "hg incoming" command (): show new changesets found in source.

Assembly

Mercurial.Net.dll

Namespace

Interfaces

Base Types

graph TD Base0["MercurialCommandBase<T>"]-->Type click Base0 "/Cake.Hg/api/Mercurial/MercurialCommandBase_1" Base1["CommandBase<T>"]-->Base0 click Base1 "/Cake.Hg/api/Mercurial/CommandBase_1" Base2["object"]-->Base1 Interface0["IMercurialCommand<TResult>"]-.->Type click Interface0 "/Cake.Hg/api/Mercurial/IMercurialCommand_1" Interface1["IMercurialCommand"]-.->Type click Interface1 "/Cake.Hg/api/Mercurial/IMercurialCommand" Interface2["ICommand"]-.->Type click Interface2 "/Cake.Hg/api/Mercurial/ICommand" Type["IncomingCommand"] class Type type-node

Syntax

public sealed class IncomingCommand : MercurialCommandBase<IncomingCommand>, 
    IMercurialCommand<IEnumerable<Changeset>>, IMercurialCommand, ICommand

Constructors

Name	Summary
IncomingCommand()	Initializes a new instance of the `IncomingCommand` class.

Properties

Name	Value	Summary
AdditionalArguments	Collection<T>	Gets the collection which additional arguments can be added into. This collection is exposed for extensions, so that they have a place to add all their extra arguments to the Mercurial command line client. Inherited from CommandBase<T>
Arguments	IEnumerable<T>	Gets all the arguments to the `Command`, or an empty array if there are none.
Branches	Collection<T>	Gets the collection of branches to include in the changesets. If empty, include all branches. Default is empty.
BundleFileName	string	Gets or sets the full path to and name of the file to store the bundles into. If you intend to pull from the same source with the same parameters after executing "incoming", you should store the bundle locally to avoid the network download twice.
Command	string	Gets the command to execute with the Mercurial command line client. Inherited from CommandBase<T>
DebugOutput	bool	Gets or sets a value indicating whether to enable debug output on the command. This should only be used by the command code itself, never by the user. Inherited from CommandBase<T>
Force	bool	Gets or sets a value indicating whether to force execution even if the source repository is unrelated.
Observer	IMercurialCommandObserver	Gets or sets the object that will act as an observer of command execution. Inherited from CommandBase<T>
RawExitCode	int	Gets the raw exit code from executing the command line client. Inherited from CommandBase<T>
RawStandardErrorOutput	string	Gets the raw standard error output from executing the command line client. Inherited from CommandBase<T>
RawStandardOutput	string	Gets the raw standard output from executing the command line client. Inherited from CommandBase<T>
RecurseSubRepositories	bool	Gets or sets a value indicating whether to recurse into subrepositories. Default is `false`.
RemoteCommand	string	Gets or sets the hg command to run on the remote side. Default is `System.String.Empty`.
Result	IEnumerable<T>	Gets the result of executing the command as a collection of `Changeset` objects.
Revisions	Collection<T>	Gets the collection of revisions to include from the `Source`. If empty, include all changes. Default is empty.
Source	string	Gets or sets the source to get new changesets from. If `System.String.Empty`, get them from the default source. Default is `System.String.Empty`.
SshCommand	string	Gets or sets the ssh command to use when cloning. Default is `System.String.Empty`.
Timeout	int	Gets or sets the timeout to use when executing Mercurial commands, in seconds. Default is 60. Inherited from CommandBase<T>
VerifyServerCertificate	bool	Gets or sets a value indicating whether to verify the server certificate. If set to `false`, will ignore web.cacerts configuration. Default value is `true`.

Methods

Name	Value	Summary
AddArgument(string)	void	Adds the specified argument to the `AdditionalArguments` collection, unless it is already present. Inherited from CommandBase<T>
After(int, string, string)	void	This method is called after the command has been executed. You can use this to clean up after the command execution (like removing temporary files), and to react to the exit code from the command line client. If the exit code is considered a failure, this method should throw the correct exception. Inherited from CommandBase<T>
Before()	void	This method is called before the command is executed. You can use this to store temporary files (like a commit message or similar) that the `Arguments` refer to, before the command is executed. Inherited from CommandBase<T>
Cleanup()	void	Override this method to implement code that will execute after command line execution. Inherited from CommandBase<T>
ParseStandardOutputForResults(int, string)	void	This method should parse and store the appropriate execution result output according to the type of data the command line client would return for the command.
Prepare()	void	Override this method to implement code that will execute before command line execution. Inherited from CommandBase<T>
RequiresVersion(Version, string)	void	This method will check the current client version and throw a `System.NotSupportedException` if the current client version is older than the required one. Inherited from MercurialCommandBase<T>
ThrowOnUnsuccessfulExecution(int, string)	void	This method should throw the appropriate exception depending on the contents of the exitCode and standardErrorOutput parameters, or simply return if the execution is considered successful.
Validate()	void	Validates the command configuration. This method should throw the necessary exceptions to signal missing or incorrect configuration (like attempting to add files to the repository without specifying which files to add.)
WithAdditionalArgument(string)	T	Adds the value to the `AdditionalArguments` collection property and returns this instance. Inherited from CommandBase<T>
WithBranch(string)	IncomingCommand	Adds the value to the `Branches` collection property and returns this `IncomingCommand` instance.
WithBundleFileName(string)	IncomingCommand	Sets the `BundleFileName` property to the specified value and returns this `IncomingCommand` instance.
WithConfigurationOverride(string, string, string)	void	Adds a configuration override specification to the `AdditionalArguments` collection in the form of `section.name=value`. Inherited from MercurialCommandBase<T>
WithForce(bool)	IncomingCommand	Sets the `Force` property to the specified value and returns this `IncomingCommand` instance.
WithObserver(IMercurialCommandObserver)	T	Sets the `Observer` property to the specified value and returns this instance. Inherited from CommandBase<T>
WithRecurseSubRepositories(bool)	IncomingCommand	Sets the `RecurseSubRepositories` property to the specified value and returns this `IncomingCommand` instance.
WithRemoteCommand(string)	IncomingCommand	Sets the `RemoteCommand` property to the specified value and returns this `IncomingCommand` instance.
WithRevision(RevSpec)	IncomingCommand	Adds the value to the `Revisions` collection property and returns this `IncomingCommand` instance.
WithSshCommand(string)	IncomingCommand	Sets the `SshCommand` property to the specified value and returns this `IncomingCommand` instance.
WithTimeout(int)	T	Sets the `Timeout` property to the specified value and returns this instance. Inherited from CommandBase<T>
WithVerifyServerCertificate(bool)	IncomingCommand	Sets the `VerifyServerCertificate` property to the specified value and returns this `IncomingCommand` instance.

Extension Methods