WorkflowInstanceService.PublishCustomEvent method

Sends a custom event to a running workflow with the event payload.

Namespace:  Microsoft.SharePoint.WorkflowServices
Assembly:  Microsoft.SharePoint.WorkflowServicesBase (in Microsoft.SharePoint.WorkflowServicesBase.dll)

Syntax

'Declaration
<ClientCallableMethodAttribute> _
Public MustOverride Sub PublishCustomEvent ( _
    instance As WorkflowInstance, _
    eventName As String, _
    payload As String _
)
'Usage
Dim instance As WorkflowInstanceService
Dim instance As WorkflowInstance
Dim eventName As String
Dim payload As String

instance.PublishCustomEvent(instance, _
    eventName, payload)

[ClientCallableMethodAttribute]
public abstract void PublishCustomEvent(
    WorkflowInstance instance,
    string eventName,
    string payload
)

Parameters

• instance
  Type: Microsoft.SharePoint.WorkflowServices.WorkflowInstance

  The WorkflowInstance instance to terminate.

• eventName
  Type: System.String

  Name of the custom event.

• payload
  Type: System.String

  The custom event payload.

See also

Reference

WorkflowInstanceService class

WorkflowInstanceService members

Microsoft.SharePoint.WorkflowServices namespace