Interface ICommunicationServiceCallback
Interface used by CommunicationService to notify about calls from workflow instances through invoke based activities
Namespace: EPiServer.WorkflowFoundation.Interfaces
Assembly: EPiServer.WorkflowFoundation.dll
Version: 7.19.2Syntax
public interface ICommunicationServiceCallbackMethods
AddHistoryItem(String, String, String, Guid)
Adds a history item to an workflow instance. Useful when an workflow instance wants to log something.
Is triggered by AddHistoryItem activity
Declaration
void AddHistoryItem(string itemSubject, string itemDescription, string user, Guid instanceId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | itemSubject | The item subject. |
| System.String | itemDescription | The item description. |
| System.String | user | The user. |
| System.Guid | instanceId | The instance id. |
AddUserData(String, Object, Boolean, Guid)
Adds a serializable custom object to the UserData collection of the workflow instance. Can be used to pass data from an workflow instance so it's accessible through host.
Is triggered by AddUserData activity
Declaration
void AddUserData(string key, object value, bool logAction, Guid instanceId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | key | The key. |
| System.Object | value | The value. |
| System.Boolean | logAction | if set to |
| System.Guid | instanceId | The instance id. |
Remarks
passed object must be serializable
AssociateWithPage(PageReference, Boolean, Guid)
Associates the workflow instance with a EPiServer page. Is triggered by AssociateWithPage activity
Declaration
void AssociateWithPage(PageReference pageLink, bool logAction, Guid instanceId)Parameters
| Type | Name | Description |
|---|---|---|
| PageReference | pageLink | The page link. |
| System.Boolean | logAction | if set to |
| System.Guid | instanceId | The instance id. |
Remarks
A instance associated with a page will only recieve page related events
CreateTaskForInstance(Guid, String, String, String, DateTime, PageReference, Boolean, Boolean, Boolean, String, Dictionary<String, Object>)
Represents the CreateTask activity. Used when Workflow instances will create a task inside EPiServer
Declaration
Task CreateTaskForInstance(Guid workflowInstanceId, string assignedTo, string subject, string description, DateTime dueDate, PageReference pageLink, bool notifyByEmail, bool logAction, bool activityRelated, string eventActivityName, Dictionary<string, object> stateBag)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | workflowInstanceId | The workflow instance id. |
| System.String | assignedTo | The assigned to. |
| System.String | subject | The subject. |
| System.String | description | The description. |
| System.DateTime | dueDate | The due date. |
| PageReference | pageLink | The page link. |
| System.Boolean | notifyByEmail | if set to |
| System.Boolean | logAction | if set to |
| System.Boolean | activityRelated | if set to |
| System.String | eventActivityName | Name of the event activity. |
| System.Collections.Generic.Dictionary<System.String, System.Object> | stateBag | The state bag. |
Returns
| Type | Description |
|---|---|
| Task |
DeleteTask(Int32, Boolean, Guid)
Deletes the task.
Is triggered by DeleteTask activity
Declaration
void DeleteTask(int taskId, bool logAction, Guid instanceId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | taskId | The task id. |
| System.Boolean | logAction | if set to |
| System.Guid | instanceId | The instance id. |
DeleteTasksForInstance(Boolean, Guid)
Deletes all tasks related to the instance.
Is triggered by DeleteTasksForInstance activity
Declaration
void DeleteTasksForInstance(bool logAction, Guid instanceId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | logAction | if set to |
| System.Guid | instanceId | The instance id. |
UpdateTask(Int32, TaskStatus, String, String, String, Boolean, Boolean, Guid)
Represents the UpdateTask activity. Used when Workflow instances will update a task inside EPiServer
Declaration
void UpdateTask(int taskId, TaskStatus status, string assignTo, string taskSubject, string taskDescription, bool notifyByEmail, bool logAction, Guid instanceId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | taskId | The task id. |
| TaskStatus | status | The status. |
| System.String | assignTo | The assign to. |
| System.String | taskSubject | The task subject. |
| System.String | taskDescription | The task description. |
| System.Boolean | notifyByEmail | if set to |
| System.Boolean | logAction | if set to |
| System.Guid | instanceId | The instance id. |
