FolderSyncronizer.SyncronizeFolder Method

FolderSyncronizerSyncronizeFolder 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 folder structure in the file system.

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

Syntax

public void SyncronizeFolder(
	ConnectionId connectionId,
	SessionId sessionId,
	int folderId,
	FolderBaseCSFileFolderTypes folderType,
	bool applyPermissions
)

Public Sub SyncronizeFolder ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	folderId As Integer,
	folderType As FolderBaseCSFileFolderTypes,
	applyPermissions 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).
folderId: Type: SystemInt32
The id of the folder that should be synchronized.
folderType: Type: ContentStudio.DocumentFolderBaseCSFileFolderTypes
The type of folder (Root, Unit or Category) to be synchronized
applyPermissions: Type: SystemBoolean
Applies permissions on the folder if any direct permission entries exists for the folder. Permissions are always applied when a folder is created. Setting this value to false can improve performance.

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
DirectoryNotFoundException	The specified path is invalid (for example, it is on an unmapped drive).
UnauthorizedAccessException	The Content Studio runtime does not have the required permission. -or- Path is not a directory. -or- Path specified a read-only directory.

Content Studio permissions

Synchronize or global group admin right is required.

Remarks

If the parent folder in the file system is missing an exception is thrown. Because of this it is very important that the folders are synchronized in the correct order. The System/Assemblies folder which maps to the Bin folder is not synchronized with this method.

Reference

FolderSyncronizer Class

ContentStudio.Document Namespace