NativeSubscriptionManagerResetDocuments Method Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Clears all InProgress subscription status values for all documents. This method is used during the cleanup process performed each time the Content Studio Service Manager starts.

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

public int ResetDocuments(
	ConnectionId connectionId,
	SessionId sessionId
)

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

Return Value

Type: Int32
A Int32 that indicates the number of affected documents.
Exceptions

ExceptionCondition
CSInvalidSessionExceptionThe session is invalid
CSPermissionDeniedExceptionThe caller has no permission to perform the requested action
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

Only sessions that have the ServiceQueueAdmin global right set can execute this method successfully.

Remarks

This method is a part of the Content Studio infrastructure and is only used by the Content Studio Service Manager.

Note Note
This method is new in Content Studio version 5.2
See Also

Reference