PDFQueueManager.ClearQueue Method

PDFQueueManagerClearQueue Method

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Deletes a number of entries in the pdf queue. Entries can be deleted per site, unit, category or document and alternatively you can delete a single item that is in the queue.

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

Syntax

Copy

public int ClearQueue(
	ConnectionId connectionId,
	SessionId sessionId,
	int iD,
	PDFQueueManagerClearQueueScope scope,
	PDFQueueManagerClearFilter filter,
	int startEntry
)

Public Function ClearQueue ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	iD As Integer,
	scope As PDFQueueManagerClearQueueScope,
	filter As PDFQueueManagerClearFilter,
	startEntry As Integer
) 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).
iD: Type: SystemInt32
Id if the item to delete. This can be a scope identifier such as a unit or a single entry.
scope: Type: ContentStudio.PDFServicesPDFQueueManagerClearQueueScope
A delete scope. This method deletes all entries within the scope and that satisfies the supplied filter.
filter: Type: ContentStudio.PDFServicesPDFQueueManagerClearFilter
Indicates what types of entries within the specified scope should be deleted.
startEntry: Type: SystemInt32
An identifier to an entry to start deleting from. If you specify an entry that is within the scope all entries older than this are deleted. This parameter is ignored unless the Filter is ClearFilter.BeforeSpecificEntry.

Return Value

Type: Int32
The number of entries actually deleted

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 entry could not be found
SqlException	An error occurred when executing the command against the Content Studio database

Content Studio permissions

DELETE permission on the queue is required to delete processed entries unless you delete a single entry, in that case DELETE permission on the single entry is required.

Remarks

Entries that are being processed and synchronous items cannot be deleted.

Reference

PDFQueueManager Class

ContentStudio.PDFServices Namespace