Interface IWorkflowAction

This interface represents a point of extension that third party can implement to inject behavior on workflow action inside the Workflow Engine. i.e.: Discard State, Complete State, Discard Workflow, Complete Workflow Third party can implement the interface for each one of the 4 actions and then register it using the IWorkflowActionManager.

Namespace: DotNetNuke.Entities.Content.Workflow.Actions
Assembly: DotNetNuke.dll
Syntax
public interface IWorkflowAction

Methods

| Improve this Doc View Source

DoActionOnStateChanged(StateTransaction)

This method implements some action on state changed. i.e.: on Complete Workflow user can implement clear a cache or log some info.

Declaration
void DoActionOnStateChanged(StateTransaction stateTransaction)
Parameters
Type Name Description
StateTransaction stateTransaction

State transaction dto.
| Improve this Doc View Source

DoActionOnStateChanging(StateTransaction)

This method implements some action on state changed. i.e.: on Complete Workflow user can implement the publish of a pending content version.

Declaration
void DoActionOnStateChanging(StateTransaction stateTransaction)
Parameters
Type Name Description
StateTransaction stateTransaction

State transaction dto.
| Improve this Doc View Source

GetActionMessage(StateTransaction, WorkflowState)

The method gets the action message that will be sent to notify the users depending on the type of action i.e.: with action type Complete Workflow the action message represents the notification sent to the user that started the workflow.

Declaration
ActionMessage GetActionMessage(StateTransaction stateTransaction, WorkflowState currentState)
Parameters
Type Name Description
StateTransaction stateTransaction

State transaction dto.
WorkflowState currentState

Workflow state that represent the current state after the workflow action.
Returns
Type Description
ActionMessage

Action message that the engine will use to send the notification.

Extension Methods