Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
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 GetQueueSynchronousEntryStatus method.
READ permission on the document of the draft is preferred and BROWSE if the published content is preferred.
[This is preliminary documentation and is subject to change.]
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.
Namespace: ContentStudio.PDFServices
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public int AddToQueueSynchronous( ConnectionId connectionId, SessionId sessionId, DocumentId documentId, bool draftIsPrefered, string optionsXml, string footerXml, bool traverseTree, string queryStrings, PdfQueueFlags flags )
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. - optionsXml
- Type: SystemString
Xml that contains settings. This value cannot exceed MAX_PDF_OPTIONSXML_LENGTH characters in length not included the embedded footer xml element. Ignored if use default is specified and if the settings of the category does not allow users to add their own preferences while creating pdfs - footerXml
- Type: SystemString
The xml that will server as input for a footer in the generated pdf. - traverseTree
- Type: SystemBoolean
Set to true to indicate that the pdf should be generated from the passed in document and all its child documents. Ignored if use default is specified and if the settings of the category does not allow users to add their own preferences while creating pdfs - queryStrings
- Type: SystemString
Query strings to pass along to the documents when browsing them. This parameter cannot exceed MAX_PDF_QUERYSTRING_LENGTH characters in length. Ignored if use default is specified and if the settings of the category does not allow users to add their own preferences while creating pdfs - flags
- Type: ContentStudio.PDFServicesPdfQueueFlags
Additional flags used by the PDF server. Ignored if use default is specified and if the settings of the category does not allow users to add their own preferences while creating pdfs
Return Value
Type: Int32A 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 GetQueueSynchronousEntryStatus 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
See Also