NativeSubscriptionManager Class Content Studio 5.7 SDK
Content Studio Web Content Management System

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

This class contains low level methods for accessing the Subscription Service data
Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    ContentStudioCSBase
      ContentStudio.Document.SubscriptionNativeSubscriptionManager

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

public class NativeSubscriptionManager : CSBase

The NativeSubscriptionManager type exposes the following members.

Constructors

  NameDescription
Public methodNativeSubscriptionManager
Initializes a new instance of the NativeSubscriptionManager class
Top
Methods

  NameDescription
Public methodAddTestSubscriptionEventForDocument
Adds a test subscription event for a specific document. The document must belong to a category enabled for subscription.
Public methodClearSubscriptions
Removes all subscriptions on a specific definition.
Public methodCreateObjRef (Inherited from MarshalByRefObject.)
Public methodDocumentsForSubscription
Returns a list of documents that are about to be sent for subscription.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetDocumentSubscriptionProperties
Gets the subscription properties of a document.
Public methodGetHashCode (Inherited from Object.)
Public methodGetLifetimeService (Inherited from MarshalByRefObject.)
Public methodGetSubscribableCategories
Gets a list of all categories that users can subscribe to.
Public methodGetSubscribableCategory
Gets a limited subset of information of a subscribable category.
Public methodGetSubscribers
Returns a pageable list of subscribers connected to a subscription definition.
Public methodGetSubscriptionCredentials
Gets the subscription credentials.
Public methodGetSubscriptionDefinitionByAddress
Gets the subscription definition given an address and address type. This call can be used to return a list of all subscriptions for a specific subscriber (by her address).
Public methodGetSubscriptionDetails(CategoryId, SubscriptionType)
Gets subscription definition data for a category using a specific category identifier and type of subscription.
Public methodGetSubscriptionDetails(ConnectionId, SessionId, Guid)
Gets subscription definition data for a category using the specified definition identifier.
Public methodGetSubscriptionInfo
Gets a limited information about a single subscription.
Public methodGetSubscriptionsWithUserData
Gets a list of all subscribable categories with information about subscriptions for a specific address.
Public methodGetType (Inherited from Object.)
Public methodInitializeLifetimeService (Inherited from MarshalByRefObject.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodMemberwiseClone(Boolean) (Inherited from MarshalByRefObject.)
Public methodResetDocuments
Clears all InProgress subscription status values for all documents. This method is used during the cleanup process performed each time the Content Studio Service Manager starts.
Public methodSaveSubscriptionDetails
Saves the subscription details for a category.
Public methodSetDocumentSubscriptionStatus
Sets the document subscription status. This method is new in Content Studio version 5.2
Public methodSetSubscriptionCredentials
Sets the credentials to use for a category subscription.
Public methodSubscriptionActivateDeactivate
Activates or deactivates a subscription.
Public methodSubscriptionAddOrSave
Adds or updates a subscription on a subscribable category.
Public methodSubscriptionItem
Gets a subscriptions item.
Public methodToString (Inherited from Object.)
Public methodUnsubscribe(ConnectionId, String)
Remove a specific subscription.
Public methodUnsubscribe(ConnectionId, String)
Remove one or more subscriptions.
Top
Fields

  NameDescription
Public fieldStatic memberMaxEventHandlerMonikerDataLength
Defines the maximum length for the EventHandlerMoniker field in the category subscription properties. This value is constant and has the value 255;
Public fieldStatic memberMaxSenderDataLength
Defines the maximum length for the Sender field in the category subscription properties. This value is constant and has the value 255;
Public fieldStatic memberMaxSiteUrlDataLength
Defines the maximum size of the SiteUrl field in the category subscription properties. This value is constant and has the value 500;
Public fieldStatic memberMaxSubscriberAddressDataLength
Defines the maximum length of a subscriber address such as an email address. This value is constant and has the value 500.
Public fieldStatic memberMaxSubscriberNameDataLength
Defines the maximum length of a subscriber name. This value is constant and has the value 200.
Public fieldStatic memberMaxSubscriberProviderDataLength
Defines the maximum length of the name of the MemberShipProvider used to verify the subscribing user. This value is constant and has the value 200.
Public fieldStatic memberMaxUserNameDataLength
Defines the maximum size of the UserName field in the category subscription properties. This value is constant and has the value 100;
Top
Remarks

Note Note
This class is new in Content Studio version 5.2

As an alternative to the low-level methods in this class you might want to use one of the high level classes that does the same things in an object oriented way. See the See also section for more info.

See Also

Reference