FolderSyncronizer.GetFolderTreeForSyncronization Method (ConnectionId, SessionId)

FolderSyncronizerGetFolderTreeForSyncronization Method (ConnectionId, SessionId)

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

public string GetFolderTreeForSyncronization(
	ConnectionId connectionId,
	SessionId sessionId
)

Public Function GetFolderTreeForSyncronization ( 
	connectionId As ConnectionId,
	sessionId As SessionId
) As String

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).

Type: String
XML

Xml

<root>
  <folder objectid="1" objecttype="U" folder="System" />
  <folder objectid="1" objecttype="C" folder="System/AS_Date" />
</root>

Exceptions

Exception	Condition
CSException
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

Synchronize or global group admin right is required.

Remarks

This overloaded version of the method returns the entire tree from the root down.