NativeSubscriptionManager.GetSubscribableCategory Method

NativeSubscriptionManagerGetSubscribableCategory Method

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Gets a limited subset of information of a subscribable category.

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

Syntax

Copy

public string GetSubscribableCategory(
	ConnectionId connectionId,
	SessionId sessionId,
	Guid identifier
)

Public Function GetSubscribableCategory ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	identifier As Guid
) As String

Parameters

connectionId: Type: ContentStudioConnectionId
The connection id.
sessionId: Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
identifier: Type: SystemGuid
The identifier.

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"
              subscriptiontype="Integer value"
    />
    <!--more definition can follow -->
</root>

This Xml has the following elements and attributes

Return Xml syntax

Element/Attribute	Description
status	Integer: The outcome of the call, always 0
statustext	String: the textual outcome of the call, Always "Success"
definition	This element represents a found category
definition/@identifier	Guid: a global unique identifier of this data. This value can be used by external applications to connect a subscriber repository to a category
definition/@categoryid	Integer: the Content Studio identifier of this category
definition/@name	String: the name of the category
definition/@description	String: a description of the category.
definition/@subscriptiontype	Integer: the integer representation of the type of subscription.

If the identifier does not identifies a subscription definition the definition element is missing.

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

NativeSubscriptionManager Class

ContentStudio.Document.Subscription Namespace