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 must have CREATE permission on the PDF-queue, WRITE permission on the document and CREATE on the destination category in order to succeed.
[This is preliminary documentation and is subject to change.]
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.
Namespace: ContentStudio.PDFServices
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public int AddToQueueAsync( ConnectionId connectionId, SessionId sessionId, DocumentId documentId )
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.
Return Value
Type: Int32A identifier to the PDF queue item just added.
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