PDFQueueManager Class Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

This class can add, remove and list items in the PDF queue
Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    ContentStudioCSBase
      ContentStudio.PDFServicesPDFQueueManager

Namespace: ContentStudio.PDFServices
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax

public class PDFQueueManager : CSBase

The PDFQueueManager type exposes the following members.

Constructors

  NameDescription
Public methodPDFQueueManager
Initializes a new instance of the PDFQueueManager class
Top
Methods

  NameDescription
Public methodAddToQueueAsync(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.
Public methodAddToQueueAsync(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.
Public methodAddToQueueSynchronous(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.
Public methodAddToQueueSynchronous(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.
Public methodClearQueue
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.
Public methodCreateObjRef (Inherited from MarshalByRefObject.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetActiveQueuedItems
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.
Public methodGetCategoryProperties
Reads the pdf-related properties for a category.
Public methodGetContainingDocuments
Obtains a list of documents that was used as origin for a generated PDF
Public methodGetHashCode (Inherited from Object.)
Public methodGetHistoryList
Returns a pageable list of entries in the PDF queue that are processed.
Public methodGetLifetimeService (Inherited from MarshalByRefObject.)
Public methodGetPdfStatusFlags
Gets the PDF status for a certain document.
Public methodGetQueuedAsyncEntryStatus
Returns the status of an asynchronous entry in the PDF queue. Typically this procedure is used by the WaitForPDF - functionality.
Public methodGetQueuedSynchronousEntryStatus
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.
Public methodGetType (Inherited from Object.)
Public methodInitializeLifetimeService (Inherited from MarshalByRefObject.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodMemberwiseClone(Boolean) (Inherited from MarshalByRefObject.)
Public methodNextInQueue
Gets the next waiting item in the Pdf queue.
This method is new in CS 5.2
Public methodOnPdfServerEndProcessing
Notifies Content Studio that a Pdf server implementation has ended the processing of a queued job.
This method is new in CS 5.2
Public methodSetCategoryPdfProperties(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.
Public methodSetCategoryPdfProperties(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.
Public methodToString (Inherited from Object.)
Top
Fields

  NameDescription
Public fieldStatic memberMAX_PDF_OPTIONSXML_LENGTH
The maximum size of the QueryStrings parameter in the AddToQueue method
Public fieldStatic memberMAX_PDF_QUERYSTRING_LENGTH
The maximum size of the OptionsXml parameter in the AddToQueue method
Public fieldStatic memberMaxContainingDocumentsDataLength
Public fieldStatic memberMaxErrorMessageDataLength
Public fieldStatic memberMaxErrorSynchronousUrlDataLength
Public fieldStatic memberMaxServerThreadIdentifierSize
Top
See Also

Reference