Public Properties
Name | Description | |
---|---|---|
![]() |
ApplyDefinition | Specifies an XML string that defines the class, properties, and security to apply to the target document. This property's value is not supplied by the caller when the request is created, but is instead based on the parameters specified in the publish options and publish template at the time the request is submitted (it provides a snap-shot of the relevant properties and security that is to be applied to the publication document). |
![]() |
AuditedEvents | An collection of the objects containing the audited events that have occurred for the object. |
![]() |
Creator | Indicates the name of the user assigned as the creator of the object. Settability of this property is read-only for most users. For users who have been granted privileged write access ( |
![]() |
DateCreated | Indicates the date and time the object was created. The Content Engine stores dates and times using Coordinated Universal Time (UTC). Settability of this property is read-only for most users. For users who have been granted privileged write access ( |
![]() |
DateLastModified | Indicates the date and time the object was last modified. The Content Engine stores dates and times using Coordinated Universal Time (UTC). Settability of this property is read-only for most users. For users who have been granted privileged write access ( |
![]() |
DequeueHost | Specifies the host name of the server responsible for dequeuing the item. Note that a retried queue item might have a different value for each retry, depending on which server actually processed the queue item. |
![]() |
ErrorCode | Specifies an error code for a publish request that is in an error state. |
![]() |
ErrorDescription | Specifies an error description for a publish request that is in an error state. |
![]() |
Id | A representation of the Globally Unique Identifier (GUID), a unique 128-bit number, that is assigned to this Content Engine object when the object is created. When converted to a string, the Id property is typically depicted as 32 hexadecimal characters enclosed by brackets in the following format: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}. For For a given property representation, the Id property has the following characteristics:
For a newly created document object, you can override the Id property of its associated |
![]() |
InitiatingUser | The authentication provider's LDAP Distinguished Name (DN) of the user that initiated the event. This property is available for asynchronous events only. For synchronous events, get the current user from the server context. |
![]() |
InputDocument | Specifies the input document to use for this publish request. |
![]() |
LastModifier | Indicates the name of the user who last modified the object. Settability of this property is read-only for most users. For users who have been granted privileged write access ( |
![]() |
NextRetryDate | Specifies the date and time that a retry will be attempted to process a queue item (pending action) on a target object. The value of this property is set by the server to indicate the time at which the server can retry the queued item. For newly added queue items or "dead" queue items (that is, those items which have no retries left), the value is null. |
![]() |
OutputFolder | Specifies the folder where the publication document is to be filed. |
![]() |
PublicationDocument | Specifies the document to use if republishing an existing document and the option to version the current document is set. |
![]() |
PublishingStatus | Specifies the status (complete, deleting, in error, in queue, or in work) of a publish request. |
![]() |
PublishRequestType | Specifies an integer that indicates the type of publish request. This property is used internally by the Content Engine API. |
![]() |
PublishStyleTemplate | Contains a reference to the object associated with this publish request. |
![]() |
PublishTemplate | Contains a reference to the object associated with this publish request. If this property is set, the object is for a publish operation. To perform a republish operation, the property must be set and this property must be . |
![]() |
RetryCount | Specifies the number of remaining attempts to process the queue item. When the retry count reaches 0 for a queue item, the item is considered "dead" and no further retries are attempted. If you want to retry a "dead" queue item, reset the retry count from 0 to a positive number. The range of valid values is 0 to 16. |
![]() |
StatusDescription | Provides a description of the publishing status for this publish request. |