DocumentSyncronizer.SyncronizeFile Method

DocumentSyncronizerSyncronizeFile Method

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Rebuilds a document's underlying file in the file system.

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

Syntax

public void SyncronizeFile(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId,
	bool applyPermissions,
	bool synchronizeXmlContent
)

Public Sub SyncronizeFile ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	documentId As DocumentId,
	applyPermissions As Boolean,
	synchronizeXmlContent 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
The id of the document that should be synchronized.
applyPermissions: Type: SystemBoolean
Applies permissions on the file if any direct permission entries exists for the document. Permissions are always applied when a file is created.
synchronizeXmlContent: Type: SystemBoolean
The method will sync XML-data with content in the database as a part of the synchronization process. Ignored if the document is anything else than an EPT document.

Exceptions

Exception	Condition
CSException	A business rule was violated in the underlying Content Studio database
SqlException	An error occurred when executing the command against the Content Studio database

Content Studio permissions

The right to synchronize documents or global group admin right is needed to execute this method.

Remarks

If the parent folder in the file system is missing an exception is thrown.

Reference

DocumentSyncronizer Class

ContentStudio.Document Namespace