PDFQueueManager.GetActiveQueuedItems Method

PDFQueueManagerGetActiveQueuedItems Method

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

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.

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

Syntax

Copy

public string GetActiveQueuedItems(
	ConnectionId connectionId,
	SessionId sessionId,
	CategoryId categoryId
)

Public Function GetActiveQueuedItems ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	categoryId As CategoryId
) As String

Parameters

connectionId: Type: ContentStudioConnectionId
A value that identifies the web site
sessionId: Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
categoryId: Type: ContentStudio.DocumentCategoryId
A category to examine. To see entries in the entire queue this parameter should be zero.

Return Value

Type: String
Xml.

Copy

<root>
    <status>0</status>
    <statustext>Success</statustext>
    <queue>
        <queueitem queueentryid=""
                   isprocessing=""
                   revision=""
                   documentid=""
                   documentname=""
                   date=""
                   startprocessing=""
                   submitter=""
                   issynchronous=""
                   querystrings=""
                   flags=""
                   footerxml="" />
        <!-- more items can follow -->
    </queue>
</root>

Exceptions

Exception	Condition
CSException	A business rule was violated in the underlying Content Studio database
CSPermissionDeniedException	The caller has no permission to perform the requested action
CSInvalidSessionException	The session is invalid
CSInvalidParameterException	A parameter has an invalid value
CSDocumentNotFoundException	The document could not be found
SqlException	An error occurred when executing the command against the Content Studio database

Content Studio permissions

READ permission on the PDF queue is required.

Reference

PDFQueueManager Class

ContentStudio.PDFServices Namespace