Class WorkflowRequestFactory
Inheritance
System.Object
WorkflowRequestFactory
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Assembly: EPiServer.Social.Moderation.Rest.dll
Version: 1.5.4
Syntax
public class WorkflowRequestFactory : IWorkflowRequestFactory
Constructors
WorkflowRequestFactory()
Declaration
public WorkflowRequestFactory()
Methods
BeginTransitionSession(BeginTransitionSessionRequest)
Generates an HttpRequestMessage instance for requesting exclusive access to add workflow items for
a target within a particular workflow.
Declaration
public HttpRequestMessage BeginTransitionSession(BeginTransitionSessionRequest session)
Parameters
Returns
| Type |
Description |
| System.Net.Http.HttpRequestMessage |
|
Create(AddWorkflowRequest)
Generates an HttpRequestMessage instance for adding a workflow.
Declaration
public 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
public 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
public 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
public 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
public HttpRequestMessage GetByCriteria(GetWorkflowsByCriteriaRequest request)
Parameters
| Type |
Name |
Description |
| GetWorkflowsByCriteriaRequest |
request |
An instance of GetWorkflowsByCriteriaRequest containing the criteria to filter workflows by
|
Returns
| Type |
Description |
| System.Net.Http.HttpRequestMessage |
|
Implements