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

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

Sets the document subscription status. This method is new in Content Studio version 5.2

Namespace: ContentStudio.Document.Subscription
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
Copy
public void SetDocumentSubscriptionStatus(
	DocumentId documentId,
	DocumentSubscriptionStatus newStatus
)

Parameters

documentId
Type: ContentStudio.DocumentDocumentId
The document identifier.
newStatus
Type: ContentStudio.Document.SubscriptionDocumentSubscriptionStatus
The new status to set.
Exceptions
ExceptionCondition
CSExceptionA business rule was violated in the underlying Content Studio database
CSPermissionDeniedExceptionThe caller has no permission to perform the requested action
CSInvalidSessionExceptionThe session is invalid
CSInvalidParameterExceptionA parameter has an invalid value
CSDocumentNotFoundExceptionThe document could not be found
InvalidOperationException The status change operation failed because the current status cannot be set to %newValue%.
SqlException An error occurred when executing the command against the Content Studio database
Content Studio permissions
ServiceQueueAdmin global right is required unless the status is set to either CanBeSent, SendNextTime or Normal and the current status is not Waiting, in that case WriteContainer permission on the document's category is sufficient.
Remarks
Note Note
This method is called by the Service Manager and is primarily not intended for public use. Applications should use the DocumentSubscriptionProperties class instead.
See Also

Reference

NativeSubscriptionManager Class
ContentStudio.Document.Subscription Namespace