Home > @tridion-sites/models > PublishTransaction
Signature:
export declare class PublishTransaction<TListInfo extends ListInfoDictionary = ListInfoDictionary> extends SystemWideObject<TListInfo>
Extends: SystemWideObject
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)({ backendModel, creator, deployerAction, instruction, items, priority, publishContexts, state, targetType, stateChangeDateTime, …systemWideObjectConstructorArgs }) | Constructs a new instance of the PublishTransaction class |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| _backendModel | BackendPublishTransaction | ||
| creator | Link | undefined | User that created this “PublishTransaction” by publishing item(s). | |
| deployerAction | DeployerAction | undefined | Action the deployer should take. | |
| getInternalModel | () => BackendPublishTransaction | ||
| hasRenderFailures | boolean | undefined | Gets a value indicating whether one of the “PublishContext.ProcessedItems” in this instance has render failures. | |
| information | string | undefined | Information about this publish transaction. | |
| instruction | PublishInstructionBase | undefined | Instruction of this instance. | |
| isCompleted | boolean | undefined | Value whether the publishing of the “PublishTransaction” is finished.This property is set to true when the transaction is in the one of the final states: “PublishTransactionState.Success”, “PublishTransactionState.Failed”, “PublishTransactionState.Warning”; otherwise, false. | |
| items | ReadonlyArray<Link> | undefined | Collection of items that need to be published or unpublished. | |
| priority | PublishPriority | undefined | Priority of this instance. It can be one of three values: low, normal or high. Transactions are executed according to this priority. | |
| publishContexts | ReadonlyArray<PublishContext> | undefined | Collection of publish contexts that indicates where to publish/unpublish to. | |
| publisherHost | string | undefined | Name of the server with Publisher service that handles current “PublishTransaction”.The value of this property is available after a Publisher has started processing this publish transaction and is an unqualified (domainless) server name. Prior to that the value of this property is null. | |
| renderingTime | string | undefined | Time span which was spent to render “PublishTransaction”.The value of this property is available after a Publisher has finished rendering of the publish transaction. | |
| resolvingTime | string | undefined | Time span which was spent to resolve items for “PublishTransaction”.The value of this property is available after a Publisher has finished resolving of the items to be published for the publish transaction. | |
| state | PublishTransactionState | undefined | State of this instance. | |
| stateChangeDateTime | Date | undefined | Date and time in UTC when the last state change occurred. | |
| targetType | Link | undefined | Target Type for this Publish Transaction.This property might be null if associated Publication Target has none or more than one Target Type. | |
| totalExecutionTime | string | undefined | Time span which was spent for publishing “PublishTransaction”.The value of this property is available after publish transaction gets to the one of the final states (“PublishTransactionState.success”, “PublishTransactionState.warning”, “PublishTransactionState.failed”). |