NewsletterSubscriptionAction Class

Class for subscribe/unsubscribe contact to newsletter

Inheritance Hierarchy

System.Object
  CMS.WorkflowEngine.BaseWorkflowAction<BaseInfo, AutomationStateInfo, AutomationActionEnum>
    CMS.Automation.AutomationAction
      CMS.Newsletters.NewsletterSubscriptionAction

Namespace: CMS.Newsletters
Assembly: CMS.Newsletters (in CMS.Newsletters.dll) Version: 13.0.131

Syntax

public class NewsletterSubscriptionAction : AutomationAction

The NewsletterSubscriptionAction type exposes the following members.

Constructors

	Name	Description
Public method	NewsletterSubscriptionAction

Fields

	Name	Description
Public field Static member	ACTION_SUBSCRIBE	Subscribe to newsletter action parameter value.
Public field Static member	ACTION_UNSUBSCRIBE	Unsubscribe from newsletter action parameter value.
Public field Static member	INHERIT_DOUBLE_OPTIN_PARAMETER_NAME	Inherit double opt-in setting parameter name.
Public field Static member	NEWSLETTER_NAME_PARAMETER_NAME	Newsletter name parameter name.
Public field Static member	SITE_PARAMETER_NAME	Site parameter name.
Public field Static member	SUBSCRIBE_ACTION_PARAMETER_NAME	Subscribe action parameter name.

Properties

	Name	Description
Public property	Action	Gets current action - 0 for SUBSCRIBE, 1 for UNSUBSCRIBE contact.
Public property	ActionDefinition	Action definition. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	ActionStep	Current step. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	Arguments	Action arguments (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	AutomationManager	Automation manager (Inherited from AutomationAction.)
Public property	Comment	Comment used when action moves to next step. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	InfoObject	Current info object. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	InheritDoubleOptIn	If true, action uses subscribe settings from it's newsletter.
Public property	InitialStep	Current step. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	MacroResolver	Macro resolver for action. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	Manager	Manager. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	NewsletterName	Newsletter identifier.
Public property	OriginalStep	Current step. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	Parameters	Parameters of action. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	SiteName	Site name.
Public property	StateObject	Current state object. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	User	User running action. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public property	Workflow	Current workflow. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)

Methods

	Name	Description
Public method	Execute	Executes current action (Overrides BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.Execute().)
Protected method	GetDefaultMacroResolver	Gets the default macro resolver. (Inherited from AutomationAction.)
Protected method	GetResolvedParameter<ReturnType>	Gets resolved value of parameter. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public method	LogMessage	Logs message to event log. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Public method	Process	Processes action. (Inherited from BaseWorkflowAction<InfoType, StateInfoType, ActionEnumType>.)
Protected method	RefreshObject	Refreshes object instance (Inherited from AutomationAction.)