DocumentIntegrationSubscription Class

Class representing subscription to documents

Inheritance Hierarchy

System.Object
  CMS.Synchronization.AbstractIntegrationSubscription
    CMS.Synchronization.BaseIntegrationSubscription
      CMS.Synchronization.DocumentIntegrationSubscription

Namespace: CMS.Synchronization
Assembly: CMS.SynchronizationEngine (in CMS.SynchronizationEngine.dll) Version: 8.2.23

Syntax

public class DocumentIntegrationSubscription : BaseIntegrationSubscription

The DocumentIntegrationSubscription type exposes the following members.

Constructors

	Name	Description
Public method	DocumentIntegrationSubscription	Default constructor

Methods

	Name	Description
Protected method	GetRegex	Returns regular expression with pattern used to match words like 'cms.%' or 'cms.pagetemplate%' where '%' represents with 0-n characters (Inherited from BaseIntegrationSubscription.)
Protected method	IsMatch(String)	Determines whether given site name matches the SiteName property (Inherited from BaseIntegrationSubscription.)
Protected method	IsMatch(TaskTypeEnum, TaskProcessTypeEnum)	Determines whether given task type matches the TaskType property (Inherited from BaseIntegrationSubscription.)
Public method	IsMatch(GeneralizedInfo, TaskTypeEnum, TaskProcessTypeEnum)	Determines whether given info object and task type match the subscription (Inherited from BaseIntegrationSubscription.)
Public method	IsMatch(ICMSObject, TaskTypeEnum, TaskProcessTypeEnum)	Determines whether given node and task type match the subscription (Overrides BaseIntegrationSubscription.IsMatch(ICMSObject, TaskTypeEnum, TaskProcessTypeEnum).)
Public method	IsMatch(TreeNode, TaskTypeEnum, TaskProcessTypeEnum)	Determines whether given node and task type match the subscription (Inherited from BaseIntegrationSubscription.)

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	ConnectorName	Name of connector the subscription is attached to. (Inherited from BaseIntegrationSubscription.)
Public property	DocumentClassName	Class name of document to match
Public property	DocumentCultureCode	Culture code of document to match
Public property	DocumentNodeAliasPath	Alias path of document to match
Public property	SiteName	Site name of document or object to match. Use AbstractIntegrationSubscription.GLOBAL_OBJECTS to match only global objects. (Inherited from BaseIntegrationSubscription.)
Public property	TaskProcessType	Type of task processing (sync/async etc.) (Inherited from BaseIntegrationSubscription.)
Public property	TaskType	Task type of document or object to match. (Inherited from BaseIntegrationSubscription.)