WorkflowMessagingService.PublishEvent method

SharePoint 2013

Publishes an event to the workflow host.

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

Public MustOverride Function PublishEvent ( _
	eventSourceId As Guid, _
	eventName As String, _
	payload As IDictionary(Of String, Object) _
) As String
Dim instance As WorkflowMessagingService
Dim eventSourceId As Guid
Dim eventName As String
Dim payload As IDictionary(Of String, Object)
Dim returnValue As String

returnValue = instance.PublishEvent(eventSourceId, _
	eventName, payload)


Type: System.Guid

Guid that identifies the event source.

Type: System.String

Fully qualified name of the event.

Type: System.Collections.Generic.IDictionary<String, Object>

IDictionary object containing event properties as name/value pairs.

Return value

Type: System.String
Returns the event to publish.

The eventSourceId should be set to the id of the scope from which the event is railed – that is, the list id for list events, the web id for web events, or the project id for project events.

The eventSourceId parameter must be unique within the scope of a site collection ([T:Microsoft.SharePoint.SPWeb)] instance).