Subscription.GetSubscriptionInformation Method (ConnectionId, SessionId, String)

SubscriptionGetSubscriptionInformation Method (ConnectionId, SessionId, String)

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Gets information for a particular subscription.

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

Syntax

Copy

public static SubscriptionInfo GetSubscriptionInformation(
	ConnectionId connectionId,
	SessionId sessionId,
	string identifier
)

Public Shared Function GetSubscriptionInformation ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	identifier As String
) As SubscriptionInfo

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.
identifier: Type: SystemString
The identifier of the subscription to get.

Return Value

Type: SubscriptionInfo
A SubscriptionInfo object if found; otherwise null.

Exceptions

Exception	Condition
SqlException	An error occurred when communicating with the underlying database.
ArgumentNullException	Identifier cannot be null
ArgumentOutOfRangeException	The identifier has an invalid format. Must be exactly 32 characters long and must be possible to convert to a Guid.

Content Studio permissions

This method can successfully be executed by any caller that has access to a valid identifier.

Reference

Subscription Class

GetSubscriptionInformation Overload

ContentStudio.Document.Subscription Namespace