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

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

Prevents a document from being sent.

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

public void DisableSend()
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%. - or - The document is not enabled for subscription.
SqlException An error occurred when executing the command against the Content Studio database
Content Studio permissions

WriteContainer permission on the document's category is needed to stop a document from being sent.
Remarks

This command sets the status of the document to Normal which tells Content Studio Service Manager that this document should not subject to a subscription operation.

This method can only be called successfully on documents that has one of the statuses below and is enabled for subscription.

See Also

Reference