PDFQueueManager.AddToQueueSynchronous Method (ConnectionId, SessionId, DocumentId, Boolean)

PDFQueueManagerAddToQueueSynchronous Method (ConnectionId, SessionId, DocumentId, Boolean)

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

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.

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

Syntax

Copy

public int AddToQueueSynchronous(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId,
	bool draftIsPrefered
)

Public Function AddToQueueSynchronous ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	documentId As DocumentId,
	draftIsPrefered As Boolean
) As Integer

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).
documentId: Type: ContentStudio.DocumentDocumentId
The document to transfer into a pdf document. This can also be a root start document if we should traverse the tree of documents.
draftIsPrefered: Type: SystemBoolean
Set to true if the pdf should be generated from the draft if possible.

Return Value

Type: Int32
A identifier to the PDF queue item just added. The caller asks the PDF server for a url to the generated pdf by using this value with the GetQueueSyncronousEntryStatus method.

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 document of the draft is preferred and BROWSE if the published content is preferred.

Reference

PDFQueueManager Class

AddToQueueSynchronous Overload

ContentStudio.PDFServices Namespace