Content Studio Web Content Management System
SystemObject
SystemMarshalByRefObject
ContentStudioCSBase
ContentStudio.Document.SubscriptionNativeSubscriptionManager
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Top
Top
Top
[This is preliminary documentation and is subject to change.]
This class contains low level methods for accessing the Subscription Service data
Inheritance Hierarchy
SystemMarshalByRefObject
ContentStudioCSBase
ContentStudio.Document.SubscriptionNativeSubscriptionManager
Namespace: ContentStudio.Document.Subscription
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
The NativeSubscriptionManager type exposes the following members.
Constructors
Name | Description | |
---|---|---|
NativeSubscriptionManager | Initializes a new instance of the NativeSubscriptionManager class |
Methods
Name | Description | |
---|---|---|
AddTestSubscriptionEventForDocument |
Adds a test subscription event for a specific document. The document must belong to a category enabled for subscription.
| |
ClearSubscriptions |
Removes all subscriptions on a specific definition.
| |
CreateObjRef | (Inherited from MarshalByRefObject.) | |
DocumentsForSubscription |
Returns a list of documents that are about to be sent for subscription.
| |
Equals | (Inherited from Object.) | |
Finalize | (Inherited from Object.) | |
GetDocumentSubscriptionProperties |
Gets the subscription properties of a document.
| |
GetHashCode | (Inherited from Object.) | |
GetLifetimeService | (Inherited from MarshalByRefObject.) | |
GetSubscribableCategories |
Gets a list of all categories that users can subscribe to.
| |
GetSubscribableCategory |
Gets a limited subset of information of a subscribable category.
| |
GetSubscribers |
Returns a pageable list of subscribers connected to a subscription definition.
| |
GetSubscriptionCredentials |
Gets the subscription credentials.
| |
GetSubscriptionDefinitionByAddress |
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).
| |
GetSubscriptionDetails(CategoryId, SubscriptionType) |
Gets subscription definition data for a category using a specific category identifier and type of subscription.
| |
GetSubscriptionDetails(ConnectionId, SessionId, Guid) |
Gets subscription definition data for a category using the specified definition identifier.
| |
GetSubscriptionInfo |
Gets a limited information about a single subscription.
| |
GetSubscriptionsWithUserData |
Gets a list of all subscribable categories with information about subscriptions for a specific address.
| |
GetType | (Inherited from Object.) | |
InitializeLifetimeService | (Inherited from MarshalByRefObject.) | |
MemberwiseClone | (Inherited from Object.) | |
MemberwiseClone(Boolean) | (Inherited from MarshalByRefObject.) | |
ResetDocuments |
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.
| |
SaveSubscriptionDetails |
Saves the subscription details for a category.
| |
SetDocumentSubscriptionStatus |
Sets the document subscription status.
This method is new in Content Studio version 5.2
| |
SetSubscriptionCredentials |
Sets the credentials to use for a category subscription.
| |
SubscriptionActivateDeactivate |
Activates or deactivates a subscription.
| |
SubscriptionAddOrSave |
Adds or updates a subscription on a subscribable category.
| |
SubscriptionItem |
Gets a subscriptions item.
| |
ToString | (Inherited from Object.) | |
Unsubscribe(ConnectionId, String) |
Remove a specific subscription.
| |
Unsubscribe(ConnectionId, String) |
Remove one or more subscriptions.
|
Fields
Name | Description | |
---|---|---|
MaxEventHandlerMonikerDataLength |
Defines the maximum length for the EventHandlerMoniker field in the category subscription properties.
This value is constant and has the value 255;
| |
MaxSenderDataLength |
Defines the maximum length for the Sender field in the category subscription properties.
This value is constant and has the value 255;
| |
MaxSiteUrlDataLength |
Defines the maximum size of the SiteUrl field in the category subscription properties.
This value is constant and has the value 500;
| |
MaxSubscriberAddressDataLength |
Defines the maximum length of a subscriber address such as an email address.
This value is constant and has the value 500.
| |
MaxSubscriberNameDataLength |
Defines the maximum length of a subscriber name.
This value is constant and has the value 200.
| |
MaxSubscriberProviderDataLength |
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.
| |
MaxUserNameDataLength |
Defines the maximum size of the UserName field in the category subscription properties.
This value is constant and has the value 100;
|
Remarks
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