Interface IWorkflowRequestFactory
Assembly: EPiServer.Social.Moderation.Rest.Contracts.dll
Version: 1.5.4
Syntax
public interface IWorkflowRequestFactory
Methods
BeginTransitionSession(BeginTransitionSessionRequest)
Generates an HttpRequestMessage instance for requesting exclusive access to add workflow items for
a target within a particular workflow.
Declaration
HttpRequestMessage BeginTransitionSession(BeginTransitionSessionRequest session)
Parameters
Returns
| Type |
Description |
| System.Net.Http.HttpRequestMessage |
|
Create(AddWorkflowRequest)
Generates an HttpRequestMessage instance for adding a workflow.
Declaration
HttpRequestMessage Create(AddWorkflowRequest addRequest)
Parameters
Returns
| Type |
Description |
| System.Net.Http.HttpRequestMessage |
|
Delete(String)
Generates an HttpRequestMessage instance for deleting a workflow by its identifier.
Declaration
HttpRequestMessage Delete(string id)
Parameters
| Type |
Name |
Description |
| System.String |
id |
Identifier of the workflow to remove
|
Returns
| Type |
Description |
| System.Net.Http.HttpRequestMessage |
|
EndTransitionSession(String, String)
Generates an HttpRequestMessage instance that ends a transition session, relinquishing exclusive access to add workflow items for a target.
Declaration
HttpRequestMessage EndTransitionSession(string workflow, string target)
Parameters
| Type |
Name |
Description |
| System.String |
workflow |
Identifies the workflow to which access was granted
|
| System.String |
target |
Identifies the target to which access was granted
|
Returns
| Type |
Description |
| System.Net.Http.HttpRequestMessage |
|
Get(String, String)
Generates an HttpRequestMessage instance for retrieving a workflow by its identifier.
Declaration
HttpRequestMessage Get(string id, string extensionType = null)
Parameters
| Type |
Name |
Description |
| System.String |
id |
Identifier of the workflow to remove
|
| System.String |
extensionType |
|
Returns
| Type |
Description |
| System.Net.Http.HttpRequestMessage |
|
GetByCriteria(GetWorkflowsByCriteriaRequest)
Generates an HttpRequestMessage instance for retreiving workflows by criteria.
Declaration
HttpRequestMessage GetByCriteria(GetWorkflowsByCriteriaRequest request)
Parameters
Returns
| Type |
Description |
| System.Net.Http.HttpRequestMessage |
|