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

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

Gets the subscription properties of a document.

Namespace: ContentStudio.Document.Subscription
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
Copy
public string GetDocumentSubscriptionProperties(
	DocumentId documentId,
	SubscriptionType subscriptionType
)

Parameters

documentId
Type: ContentStudio.DocumentDocumentId
The document identifier.
subscriptionType
Type: ContentStudio.Document.SubscriptionSubscriptionType
The type of the subscription to list. Currently only Newsletter is valid.

Return Value

Type: String

Xml

Copy
<root>
    <status>0</status>
    <statustext>Success</statustext>
    <document name="String value" 
              substat="String value" 
              categoryid="Integer value" 
              enabled="BooleanString value"/>
</root>

The returned xml has the following parts and meaning

Element/attributeValue
root/statusInteger: Indicates the outcome of the call, always 0
root/statustextString: Indicates the textual outcome of the call, always 'Success'
root/document@nameString: The name of the document.
root/document@substatString: The string representation of the DocumentSubscriptionStatus enumeration member that represents the status.
root/document@categoryidInteger: The identifier of the document's category.
root/document@enabledBooleanString ('True' or 'False'): Indicates whether the document's category is enabled for subscription.
Exceptions
ExceptionCondition
CSExceptionA business rule was violated in the underlying Content Studio database
CSPermissionDeniedExceptionThe caller has no permission to perform the requested action
CSInvalidSessionExceptionThe session is invalid
CSInvalidParameterExceptionA parameter has an invalid value
CSDocumentNotFoundExceptionThe document could not be found
NotSupportedExceptionThe value of the subscriptionType is not supported.
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions
ServiceQueueAdmin global right or READ permission on the document is required.
Remarks
Note Note
This method is called by the Service Manager and is not primarily intended for public use. Applications should use the DocumentSubscriptionProperties class instead. This method is new in Content Studio 5.2
See Also

Reference

NativeSubscriptionManager Class
ContentStudio.Document.Subscription Namespace