tridion-sites-extensions-api-docs

Home > @tridion-sites/models > Activity

Activity class

Abstract base class for the data of Activities.

Signature:

export declare abstract class Activity extends WorkflowObject

Extends: WorkflowObject

Constructors

Constructor Modifiers Description
(constructor)({ assignee, assignmentDate, backendModel, dueDate, finishDate, owner, primarySubject, process, startDate, suspendDate, workItems, …workflowObjectArgs })   Constructs a new instance of the Activity class

Properties

Property Modifiers Type Description
_backendModel   BackendActivity  
assignee   Link | undefined User or Group to which the Activity is assigned.
assignmentDate   Date | undefined The most recent assigned/re-assigned date and time in UTC of the Activity. Initially the Assignment date and Creation date are the same, upon re-assign of the activity this is updated to time the operation was performed.
dueDate   Date | undefined The due date and time in UTC for finishing activity.
finishDate   Date | undefined The date and time in UTC at which the Activity has been finished. The date/time at which the Activity has been finished or undefined if the Activity has not been finished yet.
finishMessage   string | undefined The message provided by the User who finished the Activity. If the Activity has not been finished yet this will be an empty string.
getInternalModel   () => BackendActivity  
owner   Link | undefined User who owns the Activity. The User who starts an Activity becomes the owner of the Activity. Ownership can be transferred to someone else using the ReAssign method. Only the owner can Finish the Activity.
position   number | undefined The position of the current Activity within the Process.
primarySubject   Link | undefined Primary Subject of the Activity. If the Activity has exactly one Subject, this is the Primary Subject. If the Activity has multiple Subjects, but one is a Bundle, the Bundle is the Primary Subject. In all other cases, Primary Subject is a undefined.
process   Link | undefined Process which contains the Activity. If the Activity is read in context of its containing Process, this property is undefined; it only has a value if the Activity is read stand-alone.
startDate   Date | undefined The date and time in UTC at which the Activity was started (for the first time). If the Activity is not started yet, the value is undefined.
suspendDate   Date | undefined The date and time in UTC at which the automated Activity was suspended or failed (the last time). If the Activity has not been suspended or failed (yet), the value is undefined.
workItems   ReadonlyArray<WorkItem> | undefined Work Items involved in the Activity. An Activity contains a Work Item for each Content Manager item (“subject”) involved in the Activity.