ListManager.GetList Method

ListManagerGetList 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 object that represents a list definition in Content Studio.

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

Syntax

Copy

public IEnumerable<ListDefinition> GetList(
	ConnectionId connectionId,
	SessionId sessionId
)

Public Function GetList ( 
	connectionId As ConnectionId,
	sessionId As SessionId
) 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).

Return Value

Type: IEnumerableListDefinition
A list of ListDefinitionDetail object that represent all the list definitions where the caller has the required permission

Exceptions

Exception	Condition
CSInvalidSessionException
SqlException

Content Studio permissions

Only list definitions where the caller has the READ permission on the category that forms the list definition are returned. Anonymous calls are supported.

Remarks

This method was added in Content Studio 5.6

Reference

ListManager Class

ContentStudio.Document.Listing Namespace