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 one or more subscriptions.

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

Syntax

public int Unsubscribe(
	ConnectionId connectionId,
	string[] keys
)

Public Function Unsubscribe ( 
	connectionId As ConnectionId,
	keys As String()
) As Integer

connectionId: Type: ContentStudioConnectionId
A value that identifies the web site
keys: Type: SystemString
An array of string identifier to the subscription to remove.
The value of the individual members in 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 keys.

Type: Int32
The number of subscription actually removed.

Exceptions

Exception	Condition
ArgumentNullException	keys cannot be null - or - one or more of the members in the keys parameter is null.
ArgumentOutOfRangeException	One of more members in the keys parameter is in the wrong format.
FormatException	The keys is in the wrong format.
OverflowException	The keys 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 valid identifiers in keys can successfully execute this method.

Remarks

Note
This method is new in Content Studio 5.2