Represents a queued request to publish a document using a specified PublishTemplate object. All publish requests are processed asynchronously, including copy operations, which do not transform the document. Once a PublishRequest object is saved, it is always enqueued. In IBM Content Foundation, the IBM FileNet Rendition Engine is not supported. Therefore, this class cannot be used for transform publishing. It can only be used for copy publishing or DITA publishing.

A publish request can be for a publish or republish operation, as determined by the PublishTemplate and PublicationDocument properties. If the PublishTemplate property is set and the PublicationDocument property is null, the request is for a publish operation. Otherwise, if the PublicationDocument property is set, the publish request is for a republish operation.

A PublishRequest object can be created by calling the Publish or Republish methods on a Document object. Alternatively, a PublishRequest can be created by calling Factory.IPublishRequest.CreateInstance and filling in the desired properties prior to saving. In either case, when the object is saved, it goes into the publish request queue, where it will be processed asynchronously by a publishing event handler.

Once a PublishRequest object has been successfully processed, it is deleted from the server.

Namespace:  FileNet.Api.Publishing
Assembly:  FileNet.Api (in FileNet.Api.dll)

ToggleSyntax

Visual Basic (Declaration)
Public Interface IPublishRequest _
	Implements IRepositoryObject, ISubscribable, IIndependentlyPersistableObject, IIndependentObject,  _
	IEngineObject, ICloneable
C#
public interface IPublishRequest : IRepositoryObject, 
	ISubscribable, IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable
Visual C++
public interface class IPublishRequest : IRepositoryObject, 
	ISubscribable, IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable
JavaScript
FileNet.Api.Publishing.IPublishRequest = function();
FileNet.Api.Publishing.IPublishRequest.createInterface('FileNet.Api.Publishing.IPublishRequest');

ToggleRemarks

Metadata

Auditable: true
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: SubscribableClassDefinition
IsDependent: false
IsHidden: true
Name: Id
Searchable: true
StorageType: ObjectStore
SuperclassName: Subscribable

ToggleSee Also