Content Studio Web Content Management System
Top
[This is preliminary documentation and is subject to change.]
The PDFQueueManager type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
|
AddToQueueAsync(ConnectionId, SessionId, DocumentId) |
Adds a new asynchronous entry to the PDF queue using the predefined settings.
The document added must exist and be published but cannot be of the uploaded file type.
|
|
|
AddToQueueAsync(ConnectionId, SessionId, DocumentId, CategoryId, NotificationType, PDFNotificationWhen, Boolean, String, Boolean, String, PdfQueueFlags) |
Adds a new asynchronous entry to the PDF queue.
The document added must exist and be published but cannot be of the uploaded file type. The destination category must exist and be of the uploaded file type.
|
|
|
AddToQueueSynchronous(ConnectionId, SessionId, DocumentId, Boolean) |
Creates a new synchronous pdf job by using the default properties defined on the category settings.
The document added must exist and cannot be of the uploaded binary file.
The entry created is marked as being synchronous and is given higher priority than ordinary queued entries. The caller then queries the queue until she sees the result of the job.
This call supports anonymous calls.
|
|
|
AddToQueueSynchronous(ConnectionId, SessionId, DocumentId, Boolean, String, String, Boolean, String, PdfQueueFlags) |
Creates a new synchronous pdf job.
The document added must exist and cannot be of the uploaded binary file.
The entry created is marked as being synchronous and is given higher priority than ordinary queued entries. The caller then queries the queue until she sees the result of the job.
This call supports anonymous calls.
|
|
|
ClearQueue |
Deletes a number of entries in the pdf queue. Entries can be deleted per site, unit, category or document and alternatively you can delete a single item that is in the queue.
|
|
|
CreateObjRef | (Inherited from MarshalByRefObject.) |
|
|
Equals | (Inherited from Object.) |
|
Finalize | (Inherited from Object.) |
|
|
GetActiveQueuedItems |
Returns the all entries in the PDF queue that are unprocessed or is being processed.
To get a list of archived entries use the GetHistoryList method.
|
|
|
GetCategoryProperties |
Reads the pdf-related properties for a category.
|
|
|
GetContainingDocuments |
Obtains a list of documents that was used as origin for a generated PDF
|
|
|
GetHashCode | (Inherited from Object.) |
|
|
GetHistoryList |
Returns a pageable list of entries in the PDF queue that are processed.
|
|
|
GetLifetimeService | (Inherited from MarshalByRefObject.) |
|
|
GetPdfStatusFlags |
Gets the PDF status for a certain document.
|
|
|
GetQueuedAsyncEntryStatus |
Returns the status of an asynchronous entry in the PDF queue. Typically this procedure is used by the WaitForPDF - functionality.
|
|
|
GetQueuedSynchronousEntryStatus |
Returns the status of an synchronous entry in the PDF queue.
This procedure is used to query the pdf server when making a pdf synchronously.
|
|
|
GetType | (Inherited from Object.) |
|
|
InitializeLifetimeService | (Inherited from MarshalByRefObject.) |
|
|
MemberwiseClone | (Inherited from Object.) |
|
|
MemberwiseClone(Boolean) | (Inherited from MarshalByRefObject.) |
|
|
NextInQueue |
Gets the next waiting item in the Pdf queue.
This method is new in CS 5.2 |
|
|
OnPdfServerEndProcessing |
Notifies Content Studio that a Pdf server implementation has ended the processing of a queued job.
This method is new in CS 5.2 |
|
|
SetCategoryPdfProperties(ConnectionId, SessionId, String, Int32, String) |
Sets PDF related settings on a category. These are used as default values for pdf to generate if the caller does not supply her own setting during the create process.
|
|
|
SetCategoryPdfProperties(ConnectionId, SessionId, CategoryId, Boolean, CategoryId, NotificationType, PDFNotificationWhen, Boolean, Boolean, Boolean, String, String, PdfCategoryStatusFlags) |
Sets Pdf related settings on a category. These are used as default values for pdf to generate if the caller does not supply her own setting during the create process.
|
|
|
ToString | (Inherited from Object.) |
See Also