DocumentComponentSupport.RandomizeDocument Method (ConnectionId, SessionId, CategoryId)

DocumentComponentSupportRandomizeDocument Method (ConnectionId, SessionId, CategoryId)

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Returns a randomly selected document that belongs to a certain category.

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

Syntax

public int RandomizeDocument(
	ConnectionId connectionId,
	SessionId sessionId,
	CategoryId categoryId
)

Public Function RandomizeDocument ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	categoryId As CategoryId
) As Integer

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
The category from where to return the document.

Type: Int32
Integer, the id of a document found.

Exceptions

Exception	Condition
SqlException	An error occurred when executing the command against the Content Studio database

Content Studio permissions

Supports anonymous calls. Any user can call this method but BROWSE permission on the category is required.