SubscriptionDefinition.SubscriptionsBySubscriber Method

SubscriptionDefinitionSubscriptionsBySubscriber Method

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Gets a list of subscriptions for a for the specified subscriber.

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

Syntax

Copy

public static ReadOnlyCollection<SubscriptionDefinitionListItem> SubscriptionsBySubscriber(
	ConnectionId connectionId,
	SessionId sessionId,
	string address,
	SubscriberAddressType addressType,
	bool includeDisabled
)

Public Shared Function SubscriptionsBySubscriber ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	address As String,
	addressType As SubscriberAddressType,
	includeDisabled As Boolean
) As ReadOnlyCollection(Of SubscriptionDefinitionListItem)

Parameters

connectionId: Type: ContentStudioConnectionId
A value that identifies the web site
sessionId: Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value typically is retrieved from a call to the OpenSession method
address: Type: SystemString
The subscriber's address.
addressType: Type: ContentStudio.Document.SubscriptionSubscriberAddressType
The type of address represented by the parameter.
includeDisabled: Type: SystemBoolean
Defines whether the list includes disabled subscription definitions or not.

Return Value

Type: ReadOnlyCollectionSubscriptionDefinitionListItem
A ReadOnlyCollectionT of SubscriptionDefinitionListItem object that represents a the subscriptions that the subscriber has subscribed to.

Exceptions

Exception	Condition
SqlException	An error occurred when executing the command against the Content Studio database
NotSupportedException	The value of the addressType is not supported.

Content Studio permissions

Anyone, including anonymous caller, can successfully execute this method.

Remarks

This method can be used when building a "My subscriptions" application.

Reference

SubscriptionDefinition Class

ContentStudio.Document.Subscription Namespace