DocumentReaderGetDocumentsInRecyclingBin Method Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Gets a list of documents in the recycling bin.

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

public IPagedResult<IRecyclingBinItem> GetDocumentsInRecyclingBin(
	ConnectionId connectionId,
	SessionId sessionId,
	bool documentsForCallerOnly,
	DocumentReaderDocumentListSortOrder sortOrder,
	int currentId,
	int pageSize,
	int pageNumber
)

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).
documentsForCallerOnly
Type: SystemBoolean
Determines whether to return documents deleted by the caller only (true) or by anyone (false).
sortOrder
Type: ContentStudio.DocumentDocumentReaderDocumentListSortOrder
A member in the DocumentReaderDocumentListSortOrder enumeration that specifies the sort order of the list.
currentId
Type: SystemInt32
The current id. Currently not used, pass zero (0).
pageSize
Type: SystemInt32
The size of the paging to use. If this value is zero or negative 1 is used.
pageNumber
Type: SystemInt32
The page to return.

Return Value

Type: IPagedResultIRecyclingBinItem
An IPagedResultTResult implementation that contains the result as a list of IRecyclingBinItem implementations and paging data.
Exceptions

ExceptionCondition
CSInvalidSessionExceptionThe session is invalid.
CSInvalidParameterExceptionsortOrder has an unsupported value.
SqlException
Content Studio permissions

Any non-anonymous user with a valid session can successfully execute this method.
Remarks

This method was introduced in Content Studio 5.3.
See Also

Reference