Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Any non-anonymous user with a valid session can successfully execute this method.
This method was introduced in Content Studio 5.3.
[This is preliminary documentation and is subject to change.]
Gets a list of documents in the recycling bin as xml that can be used by the
document list in Content Studio.
Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public string GetDocumentsInRecyclingBinXml( 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 pageing to use. If this value is zero or negative 1 is used. - pageNumber
- Type: SystemInt32
The page to return.
Return Value
Type: StringXml
<root> <status>0</status> <statustext>Success</statustext> <pageno>1</pageno> <pagecount>1</pagecount> <recordcount>1</recordcount> <unitid>40</unitid> <parentid>561</parentid> <module>Dokument</module> <location>MyUnit/HTML/</location> <categoryid>561</categoryid> <isenabledforpdf>0</isenabledforpdf> <documents> <document publishstatus="3" id="4420" name="HelloCS5" type="text/html" modified="2007-02-28T15:27:57.323" filename="MyUnit/HTML/BCC7232E-BD9F-4112-9929-275EE7121204.aspx" checkoutstatus="1" publishdate="2007-02-28T15:25:00" filesize="996" revisionstatus="3" deleteddate="2010-02-01T15:00:16" wfstatustext="" description="" contentsize="0" imagesavailable="0" virtualpath="" deletedById="3459" deletedBy="Monroe Marilyn" originalcategoryid="345" originalcategoryname="MyUnit/HTML"> <user createdby="John Oscar" /> </document> <!-- more documents follow --> </documents> </root>
Element/Attribute | Description |
---|---|
root/status | Integer: Indicates the outcome of the call, always 0 which indicates success |
root/statustext | String: The textual representation of the status, always OK |
root/pageno | Integer: |
root/pagecount | Integer: the number of data pages found. |
root/recordcount | Integer: the total number of records found. |
root/unitid | Integer: an identifier of the unit of the document's category. |
root/parentid | Integer: an identifier of the parent of the of the document's category.. |
root/module | Description |
root/location | String: The relative path name to the category referenced by the document's category. (e.g. MyUnit/TheCategory). |
root/categoryid | Integer: The category identifier. |
root/isenabledforpdf | Bit: 1 if the category of the document's category uses a PDF-server; otherwise, 0. |
root/documents | Document list container element. |
root/documents/document | Element that contains attributes that represents properties of a document returned. |
root/documents/document/@publishstatus | Integer: for more information see below |
root/documents/document/@id | Integer: The numeric identifier of the document |
root/documents/document/@name | String: the document name |
root/documents/document/@type | String: the mime type of the document e.g. text/html |
root/documents/document/@modified | Sortable DateTime value: indicates when the document was last modified e.g. 2007-02-28T15:27:57.323. |
root/documents/document/@filename | String: the name of the file in the file system that represents this document. |
root/documents/document/@checkoutstatus | Integer: for more information about this attribute: see section below. |
root/documents/document/@publishdate | Sortable DateTime value: indicates when the document can be published e.g. 2007-02-28T15:27:57.323. |
root/documents/document/@filesize | Integer: the size (in bytes) of the file in the file system that represents this document. |
root/documents/document/@revisionstatus | Integer: for more information see below |
root/documents/document/@deleteddate | Sortable DateTime value: indicates when the document was deleted e.g. 2007-02-28T15:27:57.323. Empty or missing if not deleted. |
root/documents/document/@wfstatustext | String: the workflow status text. Empty unless workflow is used. |
root/documents/document/@description | >String: the description of the document. |
root/documents/document/@contentsize | >Integer: the size (in bytes) of the raw content of the document when stored in the database. |
root/documents/document/@imagesavailable | Integer: indicates how the image processor scales images uploaded. Value is one of the numeric values of the ImagesAvailable enumeration. |
root/documents/document/@virtualpath | String: the virtual path of the document or empty. |
root/documents/document/@deletedById | Integer: the internal identifier of the user that deleted the document. |
root/documents/document/@deletedBy | String: the name of the user that deleted the document. |
root/documents/document/@originalcategoryid | Integer: Reserved for future use; the original category id where the document was located before it was deleted. |
root/documents/document/@originalcategoryname | String: Reserved for future use; the name of the original category where the document was located before it was deleted. |
root/documents/document/user | Element that contains attributes with information about the user that created the document. |
root/documents/document/user/@createdby | >String: the name of the user that created the document |
Exceptions
Exception | Condition |
---|---|
CSInvalidSessionException | The session is invalid. |
CSInvalidParameterException | sortOrder has an unsupported value. |
SqlException |
Content Studio permissions
Remarks
Programmers that write their own code might like to use the alternative method GetDocumentsInRecyclingBin instead which is easier and more friendly to use.
See Also