DocumentSyncronizer.GetDocumentListForSyncronization Method

DocumentSyncronizerGetDocumentListForSyncronization Method

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Builds a paged list of documents in a category that should be synchronized.

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

Syntax

public string GetDocumentListForSyncronization(
	ConnectionId connectionId,
	SessionId sessionId,
	CategoryId categoryId,
	int pageSize,
	int pageNumber,
	out int pageCount,
	out int recordCount
)

Public Function GetDocumentListForSyncronization ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	categoryId As CategoryId,
	pageSize As Integer,
	pageNumber As Integer,
	<OutAttribute> ByRef pageCount As Integer,
	<OutAttribute> ByRef recordCount As Integer
) As String

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).
categoryId: Type: ContentStudio.DocumentCategoryId
The id of the category owning the document.
pageSize: Type: SystemInt32
The size of the pages to read. If this parameter is less than 1 pageSize will be 10.
pageNumber: Type: SystemInt32
The page number to read. If this value is less than 1 PageNumber will be 1.
pageCount: Type: SystemInt32
The total pages of data found
recordCount: Type: SystemInt32
The total entries found

Return Value

Type: String
XML

Copy

<root>
   <status>0</status>
   <statustext>Success</statustext>
   <pageno>integer value</pageno>
   <pagesize>integer value</pagesize>
   <pagecount>integer value</pagecount>
   <recordcount>integer value</recordcount>
   <documents>
      <document documentid="75" documentname="Insert document tree path" size="1610" />
   </documents>
</root>

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

Permission to read/list in the parent container is required

Reference

DocumentSyncronizer Class

ContentStudio.Document Namespace