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

public int AddToQueueAsync(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId,
	CategoryId destinationCategoryId,
	NotificationType notificationType,
	PDFNotificationWhen notificationWhen,
	bool autoArchive,
	string optionsXml,
	bool traverseTree,
	string queryStrings,
	PdfQueueFlags flags
)

Public Function AddToQueueAsync ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	documentId As DocumentId,
	destinationCategoryId As CategoryId,
	notificationType As NotificationType,
	notificationWhen As PDFNotificationWhen,
	autoArchive As Boolean,
	optionsXml As String,
	traverseTree As Boolean,
	queryStrings As String,
	flags As PdfQueueFlags
) 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.

destinationCategoryId

Type: ContentStudio.DocumentCategoryId
The category where the generated pdf documents should be created. Ignored if the settings of the category does not allow users to add their own preferences while creating pdfs

notificationType

Type: ContentStudio.NotificationsNotificationType
The type of notification to send. Ignored if the settings of the category does not allow users to add their own preferences while creating pdfs

notificationWhen

Type: ContentStudio.PDFServicesPDFNotificationWhen
Indicates when a notification should be sent. 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

autoArchive

Type: SystemBoolean
Reserved, currently not used, pass false

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 the settings of the category does not allow users to add their own preferences while creating pdfs

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 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 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 the settings of the category does not allow users to add their own preferences while creating pdfs

Return Value

Reference