SubscriptionDefinition.GetItem Method

SubscriptionDefinitionGetItem Method

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Gets limited information about a subscribable category.

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

Syntax

Copy

public static SubscriptionDefinitionListItem GetItem(
	ConnectionId connectionId,
	SessionId sessionId,
	Guid subscriptionIdentifier
)

Public Shared Function GetItem ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	subscriptionIdentifier As Guid
) As 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
subscriptionIdentifier: Type: SystemGuid
The subscription to get information for.

Return Value

Type: SubscriptionDefinitionListItem
A SubscriptionDefinitionListItem object that represents the category that can be subscribed to.

Exceptions

Exception	Condition
SqlException	An error occurred when executing the command against the Content Studio database

Content Studio permissions

Any authenticated or anonymous user can successfully call this method.

Reference

SubscriptionDefinition Class

ContentStudio.Document.Subscription Namespace