SubscriptionDefinition.RemoveSubscription Method

SubscriptionDefinitionRemoveSubscription Method

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Removes a specific subscription by using a specific connection identifier and subscription identifier. I.e removes a subscriber from their category subscription definition.

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

Syntax

Copy

public static bool RemoveSubscription(
	ConnectionId connectionId,
	string identifier
)

Public Shared Function RemoveSubscription ( 
	connectionId As ConnectionId,
	identifier As String
) As Boolean

Parameters

connectionId: Type: ContentStudioConnectionId
A value that identifies the web site
identifier: Type: SystemString
An identifier to the subscription to remove.

Return Value

Type: Boolean
true if a subscription was removed; otherwise, false

Exceptions

Exception	Condition
ArgumentNullException	identifier cannot be null
ArgumentOutOfRangeException	The identifier is in the wrong format.
FormatException	The identifier is in the wrong format.
OverflowException	The identifier is in the wrong format.
SqlException	An error occurred when executing the command against the Content Studio database

Content Studio permissions

Any caller that have access to the identifier identifier can successfully execute this method.

Reference

SubscriptionDefinition Class

ContentStudio.Document.Subscription Namespace