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

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

This class handles subscription related properties for a Content Studio document.
Inheritance Hierarchy

SystemObject
  ContentStudio.Document.SubscriptionDocumentSubscriptionProperties

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

public class DocumentSubscriptionProperties

The DocumentSubscriptionProperties type exposes the following members.

Constructors

  NameDescription
Public methodDocumentSubscriptionProperties
Initializes a new instance of the DocumentSubscriptionProperties class.
Top
Properties

  NameDescription
Public propertyCategoryId
Gets the identifier of the category of this document.
Public propertyConnectionId
Gets an integer that identifies the web site.
Public propertyDescription
Gets the description of the document whose subscription properties are loaded. This property is currently not used and always returns null (Nothing in Visual Basic).
Public propertyDocumentId
Gets the identifier of the this document.
Public propertyEnabled
Gets a value indicating whether the subscription is enabled.
Public propertyName
Gets the name of the document whose subscription properties are loaded.
Public propertySubscriptionStatus
Gets the subscription status for this document.
Public propertySubscriptionType
Gets the type of the subscription loaded.
Top
Methods

  NameDescription
Public methodDisableSend
Prevents a document from being sent.
Public methodStatic memberDocumentsForSubscription
Gets a list of documents that are about to be sent for subscription.
Public methodEnableSend
Enables a document to be sent the next time it is published or approved.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodForceSend
Forces the document to be sent at the earliest possible occasion.
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString
Returns a String that represents the current instance.
(Overrides ObjectToString.)
Top
Remarks

This class is new in Content Studio 5.2
See Also

Reference