NativeSubscriptionManager.ClearSubscriptions Method

NativeSubscriptionManagerClearSubscriptions Method

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Removes all subscriptions on a specific definition.

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

Syntax

public int ClearSubscriptions(
	ConnectionId connectionId,
	SessionId sessionId,
	Guid subscriptionDefinitionId
)

Public Function ClearSubscriptions ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	subscriptionDefinitionId As Guid
) As Integer

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).
subscriptionDefinitionId: Type: SystemGuid
An identifier to subscription definition whose subscriptions should be removed.

Type: Int32
The number of subscriptions deleted

Exceptions

Exception	Condition
CSInvalidSessionException	The session is invalid
CSPermissionDeniedException	The caller has no permission to perform the requested action
SqlException	An error occurred when executing the command against the Content Studio database
ArgumentException	The definition specified by the subscriptionDefinitionId does not exist.

Content Studio permissions

The caller must have WriteContaineraccess to the category where the subscription is defined or have GlobalGroupAdmin global right.

Remarks

Note
This method is new in Content Studio 5.2