SaaS CMS has officially launched! Learn more now.

Interface IApprovalEngineEvents

NOTE: This is a pre-release API that is UNSTABLE and might not satisfy the compatibility requirements as denoted by its associated normal version. Contains events that are raised during the running of an approval instance.

Namespace: EPiServer.Approvals
Assembly: EPiServer.dll
Version: 12.0.3
Syntax
public interface IApprovalEngineEvents

Methods

add_Aborted(AsyncEventHandler<ApprovalEventArgs>)

Declaration
void add_Aborted(AsyncEventHandler<ApprovalEventArgs> value)
Parameters
Type Name Description
AsyncEventHandler<ApprovalEventArgs> value

add_Approved(AsyncEventHandler<ApprovalEventArgs>)

Declaration
void add_Approved(AsyncEventHandler<ApprovalEventArgs> value)
Parameters
Type Name Description
AsyncEventHandler<ApprovalEventArgs> value

add_Rejected(AsyncEventHandler<ApprovalEventArgs>)

Declaration
void add_Rejected(AsyncEventHandler<ApprovalEventArgs> value)
Parameters
Type Name Description
AsyncEventHandler<ApprovalEventArgs> value

add_Started(AsyncEventHandler<ApprovalEventArgs>)

Declaration
void add_Started(AsyncEventHandler<ApprovalEventArgs> value)
Parameters
Type Name Description
AsyncEventHandler<ApprovalEventArgs> value

add_StepApproved(AsyncEventHandler<ApprovalStepEventArgs>)

Declaration
void add_StepApproved(AsyncEventHandler<ApprovalStepEventArgs> value)
Parameters
Type Name Description
AsyncEventHandler<ApprovalStepEventArgs> value

add_StepCommented(AsyncEventHandler<ApprovalStepEventArgs>)

Declaration
void add_StepCommented(AsyncEventHandler<ApprovalStepEventArgs> value)
Parameters
Type Name Description
AsyncEventHandler<ApprovalStepEventArgs> value

add_StepRejected(AsyncEventHandler<ApprovalStepEventArgs>)

Declaration
void add_StepRejected(AsyncEventHandler<ApprovalStepEventArgs> value)
Parameters
Type Name Description
AsyncEventHandler<ApprovalStepEventArgs> value

add_StepStarted(AsyncEventHandler<ApprovalStepEventArgs>)

Declaration
void add_StepStarted(AsyncEventHandler<ApprovalStepEventArgs> value)
Parameters
Type Name Description
AsyncEventHandler<ApprovalStepEventArgs> value

remove_Aborted(AsyncEventHandler<ApprovalEventArgs>)

Declaration
void remove_Aborted(AsyncEventHandler<ApprovalEventArgs> value)
Parameters
Type Name Description
AsyncEventHandler<ApprovalEventArgs> value

remove_Approved(AsyncEventHandler<ApprovalEventArgs>)

Declaration
void remove_Approved(AsyncEventHandler<ApprovalEventArgs> value)
Parameters
Type Name Description
AsyncEventHandler<ApprovalEventArgs> value

remove_Rejected(AsyncEventHandler<ApprovalEventArgs>)

Declaration
void remove_Rejected(AsyncEventHandler<ApprovalEventArgs> value)
Parameters
Type Name Description
AsyncEventHandler<ApprovalEventArgs> value

remove_Started(AsyncEventHandler<ApprovalEventArgs>)

Declaration
void remove_Started(AsyncEventHandler<ApprovalEventArgs> value)
Parameters
Type Name Description
AsyncEventHandler<ApprovalEventArgs> value

remove_StepApproved(AsyncEventHandler<ApprovalStepEventArgs>)

Declaration
void remove_StepApproved(AsyncEventHandler<ApprovalStepEventArgs> value)
Parameters
Type Name Description
AsyncEventHandler<ApprovalStepEventArgs> value

remove_StepCommented(AsyncEventHandler<ApprovalStepEventArgs>)

Declaration
void remove_StepCommented(AsyncEventHandler<ApprovalStepEventArgs> value)
Parameters
Type Name Description
AsyncEventHandler<ApprovalStepEventArgs> value

remove_StepRejected(AsyncEventHandler<ApprovalStepEventArgs>)

Declaration
void remove_StepRejected(AsyncEventHandler<ApprovalStepEventArgs> value)
Parameters
Type Name Description
AsyncEventHandler<ApprovalStepEventArgs> value

remove_StepStarted(AsyncEventHandler<ApprovalStepEventArgs>)

Declaration
void remove_StepStarted(AsyncEventHandler<ApprovalStepEventArgs> value)
Parameters
Type Name Description
AsyncEventHandler<ApprovalStepEventArgs> value

Events

Aborted

Occurs when an approval instance is aborted.

Declaration
event AsyncEventHandler<ApprovalEventArgs> Aborted
Event Type
Type Description
AsyncEventHandler<ApprovalEventArgs>

Approved

Occurs when an approval instance is approved.

Declaration
event AsyncEventHandler<ApprovalEventArgs> Approved
Event Type
Type Description
AsyncEventHandler<ApprovalEventArgs>

Rejected

Occurs when an approval instance is rejected.

Declaration
event AsyncEventHandler<ApprovalEventArgs> Rejected
Event Type
Type Description
AsyncEventHandler<ApprovalEventArgs>

Started

Occurs when an approval instance is started.

Declaration
event AsyncEventHandler<ApprovalEventArgs> Started
Event Type
Type Description
AsyncEventHandler<ApprovalEventArgs>

StepApproved

Occurs when an approval instance step is approved.

Declaration
event AsyncEventHandler<ApprovalStepEventArgs> StepApproved
Event Type
Type Description
AsyncEventHandler<ApprovalStepEventArgs>

StepCommented

Occurs when a step is commented.

Declaration
event AsyncEventHandler<ApprovalStepEventArgs> StepCommented
Event Type
Type Description
AsyncEventHandler<ApprovalStepEventArgs>

StepRejected

Occurs when an approval instance step is rejected.

Declaration
event AsyncEventHandler<ApprovalStepEventArgs> StepRejected
Event Type
Type Description
AsyncEventHandler<ApprovalStepEventArgs>

StepStarted

Occurs when an approval instance step is started.

Declaration
event AsyncEventHandler<ApprovalStepEventArgs> StepStarted
Event Type
Type Description
AsyncEventHandler<ApprovalStepEventArgs>

Extension Methods