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

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

Returns a list of documents that are about to be sent for subscription.

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

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).

Return Value

Type: String

Xml with the following syntax.

Copy
<root>
    <status>0</status>
    <statustext>Success</statustext>
    <documents>
        <document documentid="Integer value"
                categoryid="Integer value"
                name="String value" />
        <!-- more document elements can follow -->
    </documents>
</root>
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
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions
This method can only successfully be executed by sessions that have the ServiceQueueAdmin global right.
Remarks

This "low-level" method is used by the DocumentsForSubscription(ConnectionId, SessionId) method which is more intuitive and simpler to use. Content Studio Service Manager calls this method to discover all documents that should be sent for subscription.

Note Note
This method is new in Content Studio 5.2
See Also

Reference

NativeSubscriptionManager Class
ContentStudio.Document.Subscription Namespace
DocumentSubscriptionPropertiesDocumentsForSubscription(ConnectionId, SessionId)