FolderSyncronizerGetFolderTreeForSyncronization Method (ConnectionId, SessionId, Int32, FolderBaseCSFileFolderTypes) Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Builds a list of folders in the correct order for synchronization.

Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
Copy
public string GetFolderTreeForSyncronization(
	ConnectionId connectionId,
	SessionId sessionId,
	int rootFolderId,
	FolderBaseCSFileFolderTypes rootFolderType
)

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).
rootFolderId
Type: SystemInt32
The id of the folder to start listing folders for synchronization. This folder and all its children will be included.
rootFolderType
Type: ContentStudio.DocumentFolderBaseCSFileFolderTypes
The type of folder to synchronize.

Return Value

Type: String
XML
Xml
Copy
<folders count="234">
  <folder objectid="1" objecttype="U" folderpath="System" hasdirectace="0" protected="0" flags="1" />
  <folder objectid="1" objecttype="C" folderpath="System/AS_Date"  hasdirectace="0" protected="0" flags="1" />
</folders>
Exceptions
ExceptionCondition
CSExceptionA business rule was violated in the underlying Content Studio database
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions
Synchronize or global group admin right is required.
Remarks
The flags attribute is a member in the CS_SyncronizationDocumentTypes enumeration and determines the content type of the category
See Also

Reference

FolderSyncronizer Class
GetFolderTreeForSyncronization Overload
ContentStudio.Document Namespace