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

public ListDefinition Add(
	ConnectionId connectionId,
	SessionId sessionId,
	CategoryId categoryId,
	string name,
	string groupName,
	string description,
	string filter,
	string searchFilter,
	string defaultSortExpression,
	ListDefinitionVisibility visibility,
	ListType listType,
	IEnumerable<XmlFilteringFieldDefinition> fields
)

Public Function Add ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	categoryId As CategoryId,
	name As String,
	groupName As String,
	description As String,
	filter As String,
	searchFilter As String,
	defaultSortExpression As String,
	visibility As ListDefinitionVisibility,
	listType As ListType,
	fields As IEnumerable(Of XmlFilteringFieldDefinition)
) As 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).

categoryId

Type: ContentStudio.DocumentCategoryId
An identifier to the category that defines the list. The category must be either of the "XmlDocument" or "File" type.

name

Type: SystemString
The name of the list. The combination of name and groupName must be unique on the site. This parameter cannot be null or empty.

groupName

Type: SystemString
A name used to group list definitions. Use empty or null when the list should appear not grouped.

description

Type: SystemString
A description of the list or null.

filter

Type: SystemString
A filter that defines a selection of documents in the category that the list should contain. This should be written as the WHERE clause in an SQL statement with field names surrounded with brackets. E.g. [myfield]=2 AND [yourField] BETWEEN 10 AND 20. The syntax of this filter is checked for Sql-injection attacks and will throw an exception if any statement not valid is passed in.

searchFilter

Type: SystemString
A search filter. This should be written as the WHERE clause in an SQL statement with field names surrounded with brackets. E.g. [myfield]LIKE'{0}' OR [yourField]LIKE'{0}'. The syntax of this filter is checked for Sql-injection attacks and will throw an exception if any statement not valid is passed in.

defaultSortExpression

Type: SystemString
The SQL command that defines the sort instruction for the returned data. This must be sql e.g. [myfield] DESC that is valid within the ORDER BY clause and must be valid against the passed in field names. All field names must appear between brackets. The syntax of this filter is checked for Sql-injection attacks and will throw an exception if any statement not valid is passed in. This value must be sql valid in an Sql server ORDER BY clause, e.g. [myfield] DESC, and must be valid against the passed in field names. All field names must appear between brackets and must exist in the field collection.
Tip
You can get a random search order by using the NEWID() clause.

visibility

Type: ContentStudio.Document.ListingListDefinitionVisibility
A value that specifies how the list is shown.

listType

Type: ContentStudio.Document.ListingListType
The type of list to create.

fields

Type: System.Collections.GenericIEnumerableXmlFilteringFieldDefinition
A list of objects that defines what fields the filter and searchFilter should work with. All these fields must be indexed.

Return Value

This method was added in Content Studio 5.6

Starting with version 5.7 Update 1 the combination of groupName and name must be unique on the site. In earlier versions the name needed to be unique.

Reference