NativeSubscriptionManagerGetSubscribableCategories 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 all categories that users can subscribe to.

Namespace: ContentStudio.Document.Subscription
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
Copy
public string GetSubscribableCategories(
	ConnectionId connectionId,
	SessionId sessionId,
	SubscriptionType subscriptionType
)

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 usually originates from a call to OpenSession(ConnectionId).
subscriptionType
Type: ContentStudio.Document.SubscriptionSubscriptionType
The type of the subscription to list. Currently only Newsletter is valid.

Return Value

Type: String

Xml with the following syntax:

Copy
<root>
    <status>0</status>
    <statustext>Success</statustext>
    <definition identifier="Guid string value"
              categoryid="Integer value"
              name="String value"
              description="String value"
              enabled="Bit value"
              subscriptiontype="Integer value"
    />
    <!--more definition can follow -->
</root>

This Xml has the following elements and attributes

Return Xml syntax
Element/AttributeDescription
statusInteger: The outcome of the call, always 0
statustextString: the textual outcome of the call, Always "Success"
definitionThis element represents a found category
definition/@identifierGuid: a global unique identifier of this data. This value can be used by external applications to connect a subscriber repository to a category
definition/@categoryidInteger: the Content Studio identifier of this category
definition/@nameString: the name of the category
definition/@descriptionString: a description of the category.
definition/@enabledBit: 1 or 0.
definition/@subscriptiontypeInteger: the integer representation of the type of subscription.
Exceptions
ExceptionCondition
SqlExceptionAn error occurred when executing the command against the Content Studio database
NotSupportedExceptionThe value of the subscriptionType is not supported.
Content Studio permissions
Any authenticated or anonymous user can successfully call this method.
Remarks
Note Note
This method is new in Content Studio version 5.2
See Also

Reference

NativeSubscriptionManager Class
ContentStudio.Document.Subscription Namespace