Summary
- Assembly
- Mercurial
.Net .dll - Namespace
- Mercurial
- 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["OutgoingCommand"]
class Type type-node
Syntax
public sealed class OutgoingCommand : MercurialCommandBase<OutgoingCommand>,
IMercurialCommand<IEnumerable<Changeset>>, IMercurialCommand, ICommand
Constructors
Name | Summary |
---|---|
OutgoingCommand |
Initializes a new instance of the OutgoingCommand class.
|
Properties
Name | Value | Summary |
---|---|---|
AdditionalArguments | Collection |
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
|
Arguments | IEnumerable |
Gets all the arguments to the
Command , or an
empty array if there are none.
|
Command | string |
Gets the command to execute with the Mercurial command line client.
Inherited from CommandBase
|
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
|
Destination | string |
Gets or sets the destination to pull from. If
System.String.Empty , push to the
default destination. Default is System.String.Empty .
|
Force | bool |
Gets or sets a value indicating whether to run even if the repositories are unrelated. Default is
false .
|
Observer | I |
Gets or sets the object that will act as an observer of command execution.
Inherited from CommandBase
|
RawExitCode | int |
Gets the raw exit code from executing the command line client.
Inherited from CommandBase
|
Raw |
string |
Gets the raw standard error output from executing the command line client.
Inherited from CommandBase
|
RawStandardOutput | string |
Gets the raw standard output from executing the command line client.
Inherited from CommandBase
|
Recurse |
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 |
Gets the result of executing the command as a collection of
Changeset objects.
|
Revisions | Collection |
Gets the collection of revisions intended to be included in the destination.
If empty, include all changes. Default is 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
|
Verify |
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 |
void |
Adds the specified argument to the
AdditionalArguments collection,
unless it is already present.
Inherited from CommandBase
|
After |
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
|
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
|
Cleanup |
void |
Override this method to implement code that will execute after command
line execution.
Inherited from CommandBase
|
Parse |
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
|
RequiresVersion |
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
|
Throw |
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.)
|
With |
T |
Adds the value to the
AdditionalArguments collection property and
returns this instance.
Inherited from CommandBase
|
With |
void |
Adds a configuration override specification to the
AdditionalArguments
collection in the form of section.name=value .
Inherited from MercurialCommandBase
|
WithDestination |
OutgoingCommand |
Sets the
Destination property to the specified value and
returns this OutgoingCommand instance.
|
WithForce |
OutgoingCommand |
Sets the
Force property to the specified value and
returns this OutgoingCommand instance.
|
WithObserver |
T |
Sets the
Observer property to the specified value and
returns this instance.
Inherited from CommandBase
|
With |
OutgoingCommand |
Sets the
RecurseSubRepositories property to the specified value and
returns this OutgoingCommand instance.
|
WithRemoteCommand |
OutgoingCommand |
Sets the
RemoteCommand property to the specified value and
returns this OutgoingCommand instance.
|
WithRevision |
OutgoingCommand |
Adds the value to the
Revisions collection property and
returns this OutgoingCommand instance.
|
WithSshCommand |
OutgoingCommand |
Sets the
SshCommand property to the specified value and
returns this OutgoingCommand instance.
|
WithTimeout |
T |
Sets the
Timeout property to the specified value and
returns this instance.
Inherited from CommandBase
|
With |
OutgoingCommand |
Sets the
VerifyServerCertificate property to the specified value and
returns this OutgoingCommand instance.
|
Extension Methods
Name | Value | Summary |
---|---|---|
Operate |
T |
Makes the command operate on the patch repository instead of the main repository.
|