NativeSubscriptionManager.Unsubscribe Method (ConnectionId, String)

NativeSubscriptionManagerUnsubscribe Method (ConnectionId, String)

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Remove a specific subscription.

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

Syntax

public bool Unsubscribe(
	ConnectionId connectionId,
	string key
)

Public Function Unsubscribe ( 
	connectionId As ConnectionId,
	key As String
) As Boolean

connectionId: Type: ContentStudioConnectionId
A value that identifies the web site
key: Type: SystemString
An identifier to the subscription to remove.
This parameter is the same as the subscription identifier which is a Guid. However this value must be in the format 32 contiguous digits: dddddddddddddddddddddddddddddddd and Content Studio must be able to create this guid from the key.

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

Exceptions

Exception	Condition
ArgumentNullException	key cannot be null
ArgumentOutOfRangeException	The key is in the wrong format.
FormatException	The key is in the wrong format.
OverflowException	The key 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 a valid key identifier can successfully execute this method.

Remarks

Note
This method is new in Content Studio 5.2