DocumentReaderGetDocumentVersionInformation Method Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Gets the version information for the draft content of a document

Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
Copy
public DocumentVersionInformation GetDocumentVersionInformation(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId
)

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
An identifier to the document to get version information for.

Return Value

Type: DocumentVersionInformation
An object that represents various version information of a document
Exceptions
ExceptionCondition
CSInvalidSessionException
CSDocumentNotFoundException
CSPermissionDeniedException
SqlException
Content Studio permissions
No permission is required to successfully execute this method. Anonymous callers are supported.
Remarks

This method was added in Content Studio 5.6

Visual editors such as the Content Studio Webbitor uses the value returned by this method to determine whether the content has been changed i any way since to editor loaded the document.

If the document currently has no draft the returned object represents the currently approved content rather than the non-existing draft.

See Also

Reference

DocumentReader Class
ContentStudio.Document Namespace