IPublish
|
Represents a log of all of the data relevant to a publish. Publish logs consist of multiple entries.
Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.492
SyntaxThe IPublishLog type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Archived |
Gets/sets the archived value of this entity
(Inherited from IEntity) |
| AvgAssetPublishMillis | Gets/sets the average time it took each asset to publish in milliseconds. |
| AvgAssetPublishSeconds | Gets/sets the average time it took each asset to publish in seconds. |
| AvgPagePublishMillis | Gets/sets the average time it took each page to publish in milliseconds. |
| AvgPagePublishSeconds | Gets/sets the average time it took each page to publish in seconds. |
| Created |
Gets the entity's creation date.
(Inherited from IEntity) |
| CreationUser |
Gets the ID of the User who created this entity.
(Inherited from IEntity) |
| ErrorFileEntries | Gets/sets a collection of entries for files that errored during the publish. |
| ErrorPageEntries | Gets/sets a collection of entries for pages that errored during the publish. |
| FailedItemsCount | The total number of failed files. |
| ForcedIncremental | Gets/sets if this was a forced incremental publish. |
| Incremental | Gets/sets if this was an incremental publish. |
| LastModified |
Gets the date when the entity was most recently modified.
(Inherited from IEntity) |
| LastModifiedUser |
Gets the ID of the User who lasted edited the entity.
(Inherited from IEntity) |
| Manager |
Gets the manager that retrieved this entity instance.
(Inherited from IEntityTManager) |
| NumberOfThreads | Gets/sets the number of processes that were active on the machine during the publish. |
| PostProcessingEntries | A wrapper for information about post-published content. |
| PublishedContentEntries | Obsolete. This property is left solely for migration purpose Do not use this property to populate pub log entries. A collection of published content IDs. |
| PublishedPageEntries | Obsolete. This property deprecated, here solely to account for old logs. Do not use this property to populate pub log entries. A collection of published page IDs. |
| PublishingLogEntries | A collection of content entries. Includes a list of entries for content that successfully published as well as a list of entries for content that failed to publish. |
| PublishingTaskId | The ID of the publishing task this log is for. |
| PubTargetID | Gets/sets the ID of the corresponding . |
| PubTargetName | Gets/sets the name of the corresponding . |
| ReplicationsToPerform | Gets/sets the number of replications to perform after the publish. |
| Session |
Gets the session that retrieved this entity. An entity is always session-specific.
(Inherited from IEntity) |
| SessionId |
Gets the unique ID of the session that retrieved this entity.
(Inherited from IEntity) |
| StartTime | Gets/sets the start time of the publishing task. |
| StoppingError | Gets/sets if there was an error causing the publish to terminate. |
| StoppingErrorEntry | Gets/sets the entry explaining the error that terminated the publish. |
| SubmitTime | Gets/sets the submit time of the publishing task. |
| SubmitUser | Gets/sets the ID of the CMS user who created the publishing task. |
| SubmitUserName | Gets/sets the name of the CMS user who created the publishing task. |
| TotalAdditionalFilesGenerated | Gets/sets the total count of new content added after the publish. |
| TotalAssetLoadSeconds | Gets/sets the amount of time it took to load all the assets for the publish into a dictionary in seconds. |
| TotalAssetSerializeSeconds | Gets/sets the amount of time it took to serialize all the assets for the publish in seconds. |
| TotalAssetsPublished | Gets/sets the total number of assets that were published. |
| TotalItemsPostProcessed | Gets/sets the total count of published content manipulated after the publish. |
| TotalPageLoadSeconds | Gets/sets the amount of time it took to load all the pages for the publish into a dictionary in seconds. |
| TotalPageSerializeSeconds | Gets/sets the amount of time it took to serialize all the pages for the publish in seconds. |
| TotalPagesPublished | The total number of pages that were published. |
| TotalTimeMillis | Gets/sets the total time the publish took in milliseconds. |
| TotalTimeSeconds | Gets/sets the total time the publish took in seconds. |
Methods| Name | Description | |
|---|---|---|
 | Touch |
Updated the entity's LastModified value to the current time.
(Inherited from IEntity) |
| ValidateData |
Validates this entity's data. Implemented by concrete inheriting types.
(Inherited from IEntity) |
| ValidateUserPermission |
Validates the user permission on the current entity. Implemented by concrete inheriting types.
It is called automatically upon saving an entity.
(Inherited from IEntity) |
Events| Name | Description | |
|---|---|---|
 | AfterEntitySave |
This event is fired after a Entity object is saved.
(Inherited from IEntityEvents) |
| BeforeEntitySave |
This event is fired before any Entity object is about to be saved.
(Inherited from IEntityEvents) |
RemarksCorresponds to a completed publishing task.
See Also