WorkflowControlClient Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Allows a client to send control operations to a workflow service hosted with WorkflowServiceHost.
public ref class WorkflowControlClient : System::ServiceModel::ClientBase<System::ServiceModel::Activities::IWorkflowInstanceManagement ^>public class WorkflowControlClient : System.ServiceModel.ClientBase<System.ServiceModel.Activities.IWorkflowInstanceManagement>type WorkflowControlClient = class
inherit ClientBase<IWorkflowInstanceManagement>Public Class WorkflowControlClient
Inherits ClientBase(Of IWorkflowInstanceManagement)- Inheritance
Remarks
Use this class to control a workflow instance.
Constructors
| WorkflowControlClient() |
Initializes a new instance of the WorkflowControlClient class. |
| WorkflowControlClient(Binding, EndpointAddress) |
Initializes a new instance of the WorkflowControlClient class with the specified binding, and WorkflowControlEndpoint. |
| WorkflowControlClient(String) |
Initializes a new instance of the WorkflowControlClient class with the specified endpoint configuration. |
| WorkflowControlClient(String, EndpointAddress) |
Initializes a new instance of the WorkflowControlClient class with the specified endpoint configuration and EndpointAddress. |
| WorkflowControlClient(String, String) |
Initializes a new instance of the WorkflowControlClient class with the specified endpoint configuration and endpoint address. |
| WorkflowControlClient(WorkflowControlEndpoint) |
Initializes a new instance of the WorkflowControlClient class with the specified WorkflowControlEndpoint. |
Properties
| Channel |
Gets the inner channel used to send messages to variously configured service endpoints. (Inherited from ClientBase<TChannel>) |
| ChannelFactory |
Gets the underlying ChannelFactory<TChannel> object. (Inherited from ClientBase<TChannel>) |
| ClientCredentials |
Gets the client credentials used to call an operation. (Inherited from ClientBase<TChannel>) |
| Endpoint |
Gets the target endpoint for the service to which the WCF client can connect. (Inherited from ClientBase<TChannel>) |
| InnerChannel |
Gets the underlying IClientChannel implementation. (Inherited from ClientBase<TChannel>) |
| State |
Gets the current state of the ClientBase<TChannel> object. (Inherited from ClientBase<TChannel>) |
Methods
| Abandon(Guid) |
Abandons the specified workflow instance. |
| Abandon(Guid, String) |
Abandons the specified workflow instance. |
| AbandonAsync(Guid) |
Begins an asynchronous operation that abandons the specified workflow instance. |
| AbandonAsync(Guid, Object) |
Begins an asynchronous operation that abandons the specified workflow instance with the specified user-defined data. |
| AbandonAsync(Guid, String) |
Begins an asynchronous operation that abandons the specified workflow instance with the specified reason. |
| AbandonAsync(Guid, String, Object) |
Begins an asynchronous operation that abandons the specified workflow instance with the specified reason and user-defined data. |
| Abort() |
Causes the ClientBase<TChannel> object to transition immediately from its current state into the closed state. (Inherited from ClientBase<TChannel>) |
| BeginAbandon(Guid, AsyncCallback, Object) |
Begins an asynchronous operation that abandons the specified workflow instance. |
| BeginAbandon(Guid, String, AsyncCallback, Object) |
Begins an asynchronous operation that abandons the specified workflow instance. |
| BeginCancel(Guid, AsyncCallback, Object) |
Begins an asynchronous operation that cancels the specified workflow instance. |
| BeginRun(Guid, AsyncCallback, Object) |
Begins an asynchronous operation that runs the specified workflow instance. |
| BeginSuspend(Guid, AsyncCallback, Object) |
Begins an asynchronous operation that suspends the specified operation. |
| BeginSuspend(Guid, String, AsyncCallback, Object) |
Begins an asynchronous operation that suspends the specified operation. |
| BeginTerminate(Guid, AsyncCallback, Object) |
Begins an asynchronous operation that terminates a workflow instance. |
| BeginTerminate(Guid, String, AsyncCallback, Object) |
Begins an asynchronous operation that terminates a workflow instance. |
| BeginUnsuspend(Guid, AsyncCallback, Object) |
Begins an asynchronous operation that unsuspends a workflow instance. |
| Cancel(Guid) |
Cancels the specified workflow instance. |
| CancelAsync(Guid) |
Begins an asynchronous operation that cancels the specified workflow instance. |
| CancelAsync(Guid, Object) |
Begins an asynchronous operation that cancels the specified workflow instance with the specified user-defined data. |
| Close() |
Causes the ClientBase<TChannel> object to transition from its current state into the closed state. (Inherited from ClientBase<TChannel>) |
| CloseAsync() | (Inherited from ClientBase<TChannel>) |
| CreateChannel() |
Returns a new channel to the service. (Inherited from ClientBase<TChannel>) |
| DisplayInitializationUI() |
Instructs the inner channel to display a user interface if one is required to initialize the channel prior to using it. (Inherited from ClientBase<TChannel>) |
| EndAbandon(IAsyncResult) |
Completes an asynchronous abandon operation. |
| EndCancel(IAsyncResult) |
Completes an asynchronous cancel operation. |
| EndRun(IAsyncResult) |
Completes an asynchronous run operation. |
| EndSuspend(IAsyncResult) |
Completes an asynchronous suspend operation. |
| EndTerminate(IAsyncResult) |
Completes an asynchronous terminate operation. |
| EndUnsuspend(IAsyncResult) |
Completes an asynchronous unsuspend operation. |
| Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetDefaultValueForInitialization<T>() |
Replicates the behavior of the default keyword in C#. (Inherited from ClientBase<TChannel>) |
| GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| InvokeAsync(ClientBase<TChannel>.BeginOperationDelegate, Object[], ClientBase<TChannel>.EndOperationDelegate, SendOrPostCallback, Object) |
Provides support for implementing the event-based asynchronous pattern. For more information about this pattern, see Event-based Asynchronous Pattern Overview. (Inherited from ClientBase<TChannel>) |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| Open() |
Causes the ClientBase<TChannel> object to transition from the created state into the opened state. (Inherited from ClientBase<TChannel>) |
| Run(Guid) |
Runs the specified workflow instance. |
| RunAsync(Guid) |
Begins an asynchronous operation that runs the specified workflow instance. |
| RunAsync(Guid, Object) |
Begins an asynchronous operation that runs the specified workflow instance with the user-defined state data. |
| Suspend(Guid) |
Suspends the specified workflow instance. |
| Suspend(Guid, String) |
Suspends the specified workflow instance. |
| SuspendAsync(Guid) |
Begins an asynchronous suspend operation. |
| SuspendAsync(Guid, Object) |
Begins an asynchronous suspend operation with the specified workflow instance ID and user-defined state data. |
| SuspendAsync(Guid, String) |
Begins an asynchronous suspend operation with the specified workflow instance ID and reason. |
| SuspendAsync(Guid, String, Object) |
Begins an asynchronous suspend operation with the specified workflow instance ID, reason, and user-defined state data. |
| Terminate(Guid) |
Terminates the specified workflow instance. |
| Terminate(Guid, String) |
Terminates the specified workflow instance with the specified reason. |
| TerminateAsync(Guid) |
Begins an asynchronous operation that terminates the specified workflow instance. |
| TerminateAsync(Guid, Object) |
Begins an asynchronous operation that terminates the specified workflow instance with the specified user-defined data. |
| TerminateAsync(Guid, String) |
Begins an asynchronous operation that terminates the specified workflow instance with the specified reason. |
| TerminateAsync(Guid, String, Object) |
Begins an asynchronous operation that terminates the specified workflow instance with the specified reason and user-defined data. |
| ToString() |
Returns a string that represents the current object. (Inherited from Object) |
| Unsuspend(Guid) |
Unsuspends the specified workflow instance. |
| UnsuspendAsync(Guid) |
Begins an asynchronous unsuspend operation. |
| UnsuspendAsync(Guid, Object) |
Begins an asynchronous unsuspend operation with the specified user-defined state data. |
Events
| AbandonCompleted |
Occurs when an asynchronous abandon operation completes. |
| CancelCompleted |
Occurs when an asynchronous cancel operation completes. |
| RunCompleted |
Occurs when an asynchronous run operation completes. |
| SuspendCompleted |
Occurs when an asynchronous suspend operation completes. |
| TerminateCompleted |
Occurs when an asynchronous terminate operation completes. |
| UnsuspendCompleted |
Occurs when an asynchronous unsuspend operation completes. |
Explicit Interface Implementations
| ICommunicationObject.BeginClose(AsyncCallback, Object) |
Begins an asynchronous operation to close the ClientBase<TChannel>. (Inherited from ClientBase<TChannel>) |
| ICommunicationObject.BeginClose(TimeSpan, AsyncCallback, Object) |
Begins an asynchronous operation to close the ClientBase<TChannel> with a specified timeout. (Inherited from ClientBase<TChannel>) |
| ICommunicationObject.BeginOpen(AsyncCallback, Object) |
Begins an asynchronous operation to open the ClientBase<TChannel> object. (Inherited from ClientBase<TChannel>) |
| ICommunicationObject.BeginOpen(TimeSpan, AsyncCallback, Object) |
Begins an asynchronous operation to open the ClientBase<TChannel> object within a specified interval of time. (Inherited from ClientBase<TChannel>) |
| ICommunicationObject.Close(TimeSpan) |
Causes the ClientBase<TChannel> object to transition from its current state into the closed state. (Inherited from ClientBase<TChannel>) |
| ICommunicationObject.Closed |
The event handler that is invoked when the ClientBase<TChannel> object has transitioned from its current state to the closed state. (Inherited from ClientBase<TChannel>) |
| ICommunicationObject.Closing |
The event handler that is invoked when the ClientBase<TChannel> object transitions from its current state to the closed state. (Inherited from ClientBase<TChannel>) |
| ICommunicationObject.EndClose(IAsyncResult) |
Completes an asynchronous operation to close the ClientBase<TChannel> object. (Inherited from ClientBase<TChannel>) |
| ICommunicationObject.EndOpen(IAsyncResult) |
Completes an asynchronous operation to open the ClientBase<TChannel> object. (Inherited from ClientBase<TChannel>) |
| ICommunicationObject.Faulted |
The event handler that is invoked when a fault occurs while performing an operation on the ClientBase<TChannel> object. (Inherited from ClientBase<TChannel>) |
| ICommunicationObject.Open(TimeSpan) |
Causes the ClientBase<TChannel> object to transition from the created state into the opened state within a specified interval of time. (Inherited from ClientBase<TChannel>) |
| ICommunicationObject.Opened |
The event handler that is invoked when the ClientBase<TChannel> object transitions from the created state to the opened state. (Inherited from ClientBase<TChannel>) |
| ICommunicationObject.Opening |
The event handler that is invoked when the ClientBase<TChannel> object transitions from the created state to the opened state. (Inherited from ClientBase<TChannel>) |
| IDisposable.Dispose() |
Explicit implementation of the Dispose() method. (Inherited from ClientBase<TChannel>) |
