Represents a request to generate a thumbnail image for a ContentElement of a Document. A request is placed on the ThumbnailRequest queue table, which is processed by an instance of ICmThumbnailRequestSweep.

The system removes successfully completed thumbnail requests from the ThumbnailRequest queue table. The system also removes requests that result in managed exceptions; that is, situations where the system cannot process the request. Managed exceptions include non-existent content or source document, or attempts to overwrite a user-generated thumbnail.

For failed requests that are fixable by an administrator, the system retries the requests up to the value set on the MaximumFailures property of the ICmThumbnailRequestSweep instance (the default is six retries). If all of the retries fail, the requests remain in the queue table. A ICmThumbnailRequest object includes properties for retrieving status and failure information, and for restarting retries.

See Thumbnail Concepts.

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

ToggleSyntax

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

ToggleRemarks

Metadata

Auditable: false
AllowsInstances: true
AllowsSubClasses: true
ClassDefinitionName: CmQueueEntryClassDefinition
IsDependent: false
IsHidden: false
Name: Id
Searchable: true
StorageType: ObjectStore
SuperclassName: CmAbstractQueueEntry

ToggleSee Also