Interface IContentWorkflowController

Namespace: DotNetNuke.Entities.Content.Workflow
Assembly: DotNetNuke.dll
Syntax
[Obsolete("Deprecated in DotNetNuke 7.4.0. Use IWorkflowEngine. Scheduled for removal in v10.0.0.")]
public interface IContentWorkflowController

Methods

AddWorkflow(ContentWorkflow)

Declaration
void AddWorkflow(ContentWorkflow workflow)
Parameters
Type Name Description
ContentWorkflow workflow

AddWorkflowLog(ContentItem, string, string, int)

Declaration
void AddWorkflowLog(ContentItem item, string action, string comment, int userID)
Parameters
Type Name Description
ContentItem item
string action
string comment
int userID

AddWorkflowState(ContentWorkflowState)

Declaration
void AddWorkflowState(ContentWorkflowState state)
Parameters
Type Name Description
ContentWorkflowState state

AddWorkflowStatePermission(ContentWorkflowStatePermission, int)

Declaration
void AddWorkflowStatePermission(ContentWorkflowStatePermission permission, int lastModifiedByUserID)
Parameters
Type Name Description
ContentWorkflowStatePermission permission
int lastModifiedByUserID

CompleteState(int, string, string, string, int, int)

Declaration
void CompleteState(int itemID, string subject, string body, string comment, int portalID, int userID)
Parameters
Type Name Description
int itemID
string subject
string body
string comment
int portalID
int userID

CompleteState(int, string, string, string, int, int, string, params string[])

Declaration
void CompleteState(int itemID, string subject, string body, string comment, int portalID, int userID, string source, params string[] parameters)
Parameters
Type Name Description
int itemID
string subject
string body
string comment
int portalID
int userID
string source
string[] parameters

CompleteWorkflow(int, string, int, int)

Declaration
void CompleteWorkflow(int contentItemId, string comment, int portalId, int userId)
Parameters
Type Name Description
int contentItemId
string comment
int portalId
int userId

CreateDefaultWorkflows(int)

Declaration
void CreateDefaultWorkflows(int portalId)
Parameters
Type Name Description
int portalId

DeleteWorkflowLogs(int, int)

Declaration
void DeleteWorkflowLogs(int workflowID, int contentItemID)
Parameters
Type Name Description
int workflowID
int contentItemID

DeleteWorkflowStatePermission(int)

Declaration
void DeleteWorkflowStatePermission(int workflowStatePermissionID)
Parameters
Type Name Description
int workflowStatePermissionID

DiscardState(int, string, string, string, int, int)

Declaration
void DiscardState(int itemID, string subject, string body, string comment, int portalID, int userID)
Parameters
Type Name Description
int itemID
string subject
string body
string comment
int portalID
int userID

DiscardWorkflow(int, string, int, int)

Declaration
void DiscardWorkflow(int contentItemId, string comment, int portalId, int userId)
Parameters
Type Name Description
int contentItemId
string comment
int portalId
int userId

GetDefaultWorkflow(int)

Declaration
ContentWorkflow GetDefaultWorkflow(int portalID)
Parameters
Type Name Description
int portalID
Returns
Type Description
ContentWorkflow

GetWorkflow(ContentItem)

Declaration
ContentWorkflow GetWorkflow(ContentItem item)
Parameters
Type Name Description
ContentItem item
Returns
Type Description
ContentWorkflow

GetWorkflowByID(int)

Declaration
ContentWorkflow GetWorkflowByID(int workflowID)
Parameters
Type Name Description
int workflowID
Returns
Type Description
ContentWorkflow

GetWorkflowLogs(int, int)

Declaration
IEnumerable<ContentWorkflowLog> GetWorkflowLogs(int workflowId, int contentItemId)
Parameters
Type Name Description
int workflowId
int contentItemId
Returns
Type Description
IEnumerable<ContentWorkflowLog>

GetWorkflowSource(int, string)

Declaration
ContentWorkflowSource GetWorkflowSource(int workflowId, string sourceName)
Parameters
Type Name Description
int workflowId
string sourceName
Returns
Type Description
ContentWorkflowSource

GetWorkflowStateByID(int)

Declaration
ContentWorkflowState GetWorkflowStateByID(int stateID)
Parameters
Type Name Description
int stateID
Returns
Type Description
ContentWorkflowState

GetWorkflowStatePermissionByState(int)

Declaration
IEnumerable<ContentWorkflowStatePermission> GetWorkflowStatePermissionByState(int stateID)
Parameters
Type Name Description
int stateID
Returns
Type Description
IEnumerable<ContentWorkflowStatePermission>

GetWorkflowStates(int)

Declaration
IEnumerable<ContentWorkflowState> GetWorkflowStates(int workflowID)
Parameters
Type Name Description
int workflowID
Returns
Type Description
IEnumerable<ContentWorkflowState>

GetWorkflows(int)

Declaration
IEnumerable<ContentWorkflow> GetWorkflows(int portalID)
Parameters
Type Name Description
int portalID
Returns
Type Description
IEnumerable<ContentWorkflow>

IsAnyReviewer(int)

Declaration
bool IsAnyReviewer(int workflowID)
Parameters
Type Name Description
int workflowID
Returns
Type Description
bool

IsAnyReviewer(int, int, int)

Declaration
bool IsAnyReviewer(int portalID, int userID, int workflowID)
Parameters
Type Name Description
int portalID
int userID
int workflowID
Returns
Type Description
bool

IsCurrentReviewer(int)

Declaration
bool IsCurrentReviewer(int itemID)
Parameters
Type Name Description
int itemID
Returns
Type Description
bool

IsCurrentReviewer(int, int, int)

Declaration
bool IsCurrentReviewer(int portalId, int userID, int itemID)
Parameters
Type Name Description
int portalId
int userID
int itemID
Returns
Type Description
bool

IsReviewer(int)

Declaration
bool IsReviewer(int stateID)
Parameters
Type Name Description
int stateID
Returns
Type Description
bool

IsReviewer(int, int, int)

Declaration
bool IsReviewer(int portalId, int userID, int stateID)
Parameters
Type Name Description
int portalId
int userID
int stateID
Returns
Type Description
bool

IsWorkflowCompleted(int)

Declaration
bool IsWorkflowCompleted(int itemID)
Parameters
Type Name Description
int itemID
Returns
Type Description
bool

IsWorkflowOnDraft(int)

Declaration
bool IsWorkflowOnDraft(int itemID)
Parameters
Type Name Description
int itemID
Returns
Type Description
bool

ReplaceNotificationTokens(string, ContentWorkflow, ContentItem, ContentWorkflowState, int, int, string)

Declaration
string ReplaceNotificationTokens(string text, ContentWorkflow workflow, ContentItem item, ContentWorkflowState state, int portalID, int userID, string comment = "")
Parameters
Type Name Description
string text
ContentWorkflow workflow
ContentItem item
ContentWorkflowState state
int portalID
int userID
string comment
Returns
Type Description
string

SendWorkflowNotification(bool, bool, PortalSettings, IEnumerable<RoleInfo>, IEnumerable<UserInfo>, string, string, string, int)

Declaration
void SendWorkflowNotification(bool sendEmail, bool sendMessage, PortalSettings settings, IEnumerable<RoleInfo> roles, IEnumerable<UserInfo> users, string subject, string body, string comment, int userID)
Parameters
Type Name Description
bool sendEmail
bool sendMessage
PortalSettings settings
IEnumerable<RoleInfo> roles
IEnumerable<UserInfo> users
string subject
string body
string comment
int userID

StartWorkflow(int, int, int)

Declaration
void StartWorkflow(int workflowID, int itemID, int userID)
Parameters
Type Name Description
int workflowID
int itemID
int userID

UpdateWorkflow(ContentWorkflow)

Declaration
void UpdateWorkflow(ContentWorkflow workflow)
Parameters
Type Name Description
ContentWorkflow workflow

UpdateWorkflowState(ContentWorkflowState)

Declaration
void UpdateWorkflowState(ContentWorkflowState state)
Parameters
Type Name Description
ContentWorkflowState state

UpdateWorkflowStatePermission(ContentWorkflowStatePermission, int)

Declaration
void UpdateWorkflowStatePermission(ContentWorkflowStatePermission permission, int lasModifiedByUserId)
Parameters
Type Name Description
ContentWorkflowStatePermission permission
int lasModifiedByUserId

Extension Methods