Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Xml
BROWSE permission on the each one of the documents in the chain is required. This call supports anonymous users.
[This is preliminary documentation and is subject to change.]
Returns documents in a category from a list of documents passed in. The Insert comma separated documents Content Studio component uses this method internally.
Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public string DocumentCollection( ConnectionId connectionId, SessionId sessionId, CategoryId categoryId, int[] documentList, DocumentComponentSupportDocumentCollectionSortOrder sortOrder, int presentationTemplate, DateTime dateCriteria, PublishStatuses publishStatus )
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). - categoryId
- Type: ContentStudio.DocumentCategoryId
An identifier to a category where the documents should be listed from. This category must exists. - documentList
- Type: SystemInt32
An array of document id:s to list. - sortOrder
- Type: ContentStudio.DocumentDocumentComponentSupportDocumentCollectionSortOrder
An integer that specifies the sort order of the returned document list. - presentationTemplate
- Type: SystemInt32
An optional presentation list. If zero the default presentation template of the category is returned otherwise the passed in id. - dateCriteria
- Type: SystemDateTime
A preview date to use to be able to examine the tree taking the publish status at a given time. Normally you pass MinValue to use the current status. - publishStatus
- Type: ContentStudio.DocumentPublishStatuses
A value that indicates the publish status all of the returned document should have.
Return Value
Type: StringXml
Examples
<root> <status>0</status> <statustext>Success</statustext> <documents> <document documentid="3469" documentname="The title" publishdate="2006-12-15T09:00:00" filename="En/HTML-pages/10C03271-F1FA-4AC8-AEE5-471346CE1042.aspx" modulename="" modifieddate="2006-12-15T09:08:24.193" presentationtemplateid=">0" imagesavailable="0" /> <!-- more document element can follow --> </documents> </root>
Exceptions
Exception | Condition |
---|---|
CSException | A business rule was violated in the underlying Content Studio database |
CSPermissionDeniedException | The caller has no permission on the start document |
CSInvalidSessionException | The session is invalid |
CSInvalidParameterException | The sort order has an invalid value |
SqlException | An error occurred when executing the command against the Content Studio database |
Content Studio permissions
See Also