SubscriptionCollectionCreate Method Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Creates SubscriptionCollection that can be used to read through the collection of subscribers on a specific SubscriptionDefinition.

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

public static SubscriptionCollection Create(
	ConnectionId connectionId,
	SessionId sessionId,
	Guid subscriptionDefinitionId,
	SubscriptionType subscriptionType,
	bool activatedOnly
)

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.
subscriptionDefinitionId
Type: SystemGuid
A Guid that uniquely identifies the subscription definition that contains the meta data about the subscription.
subscriptionType
Type: ContentStudio.Document.SubscriptionSubscriptionType
Type of the subscription.
activatedOnly
Type: SystemBoolean
Indicates whether to return only activated subscriptions. If this parameter is true and the subscription is not activated on the category no subscribers are returned.

Return Value

Type: SubscriptionCollection
A new SubscriptionCollection represents the found subscriptions.
See Also

Reference