CSApprovedDocumentInformation Constructor (ConnectionId, SessionId, DocumentId, Boolean)

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Creates a new instance of the CSApprovedDocumentInformation class and loads document information using a specific connectionId, sessionId and documentId with the possibility to specify whether or not to load content data.

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

Syntax

Copy

public CSApprovedDocumentInformation(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId,
	bool loadContent
)

Public Sub New ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	documentId As DocumentId,
	loadContent As Boolean
)

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 value that identifies the document whose details should be displayed.
loadContent: Type: SystemBoolean
Indicates whether the content related data should be returned or not. Set this parameter to false unless you really need any content data such as Introduction and MenuData

Exceptions

Exception	Condition
CSPermissionDeniedException	The caller has no permission to perform the requested action
CSInvalidSessionException	The session is invalid
CSDocumentNotFoundException	The document could not be found
SqlException	An error occurred when executing the command against the Content Studio database

Content Studio permissions

BROWSE permission is required on the document.

Remarks

This constructor loads the document's meta data and optionally its content related data. The content related data is loaded from the currently approved version of the document and should there be no approved content available, no exception is thrown but the content related fields will be un-initialized.
The following properties are content related.

Property	Value when not initialized
Introduction	null (Nothing in Visual Basic)
MenuUrl	null (Nothing in Visual Basic)
MenuData	null (Nothing in Visual Basic)
MenuTarget	null (Nothing in Visual Basic)
RevisionDate	null (Nothing in Visual Basic)
Revision	Zero

Reference

CSApprovedDocumentInformation Class

CSApprovedDocumentInformation Overload

ContentStudio.Document Namespace