ListManager.GetListsByDocument Method

ListManagerGetListsByDocument Method

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Gets a collection of ListDefinition objects representing lists where the document belong. The predefined list types such as Recycling Bin or Latest activities are not included.

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

Syntax

Copy

public IEnumerable<ListDefinition> GetListsByDocument(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId
)

Public Function GetListsByDocument ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	documentId As DocumentId
) As IEnumerable(Of ListDefinition)

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
A document identifier

Return Value

Type: IEnumerableListDefinition
A list of ListDefinition objects.

Exceptions

Exception	Condition
CSInvalidSessionException
SqlException

Content Studio permissions

READ permission on the document is required. Anonymous calls are supported.

Remarks

This method was added in Content Studio 5.6

Reference

ListManager Class

ContentStudio.Document.Listing Namespace