tridion-sites-extensions-api-docs

Home > @tridion-sites/models > Batch

Batch class

Represents the data of a Batch.

Signature:

export declare class Batch extends SystemWideObject

Extends: SystemWideObject

Constructors

Constructor Modifiers Description
(constructor)({ backendModel, backendBatchOperation, operations, performer, status, type, …systemWideObjectArgs })   Constructs a new instance of the Batch class

Properties

Property Modifiers Type Description
_backendModel   BackendBatch  
getInternalModel   () => BackendBatch  
isFinished   boolean Whether all batch operations are finished.
numberOfDoneOperations   number | undefined Count of done operations.
operations   ReadonlyArray<BatchOperation> | undefined  
parameters   ParametersDictionary | undefined Additional parameters for invoking operation.
performer   Link | undefined  
startAt   string | undefined Time in UTC, when the batch operation must be started.
status   BatchStatus | undefined  
totalNumberOfOperations   number | undefined Total number of operations.
type   BatchType | undefined