Click or drag to resize
NewsletterSubscriptionAction Class
Class for subscribe/unsubscribe contact to newsletter
Inheritance Hierarchy
SystemObject
  CMS.WorkflowEngineBaseWorkflowActionBaseInfo, AutomationStateInfo, AutomationActionEnum
    CMS.AutomationAutomationAction
      CMS.NewslettersNewsletterSubscriptionAction

Namespace: CMS.Newsletters
Assembly: CMS.Newsletters (in CMS.Newsletters.dll) Version: 13.0.131
Syntax
C#
public class NewsletterSubscriptionAction : AutomationAction

The NewsletterSubscriptionAction type exposes the following members.

Constructors
  NameDescription
Public methodNewsletterSubscriptionAction
Top
Fields
  NameDescription
Public fieldStatic memberACTION_SUBSCRIBE
Subscribe to newsletter action parameter value.
Public fieldStatic memberACTION_UNSUBSCRIBE
Unsubscribe from newsletter action parameter value.
Public fieldStatic memberINHERIT_DOUBLE_OPTIN_PARAMETER_NAME
Inherit double opt-in setting parameter name.
Public fieldStatic memberNEWSLETTER_NAME_PARAMETER_NAME
Newsletter name parameter name.
Public fieldStatic memberSITE_PARAMETER_NAME
Site parameter name.
Public fieldStatic memberSUBSCRIBE_ACTION_PARAMETER_NAME
Subscribe action parameter name.
Top
Properties
  NameDescription
Public propertyAction
Gets current action - 0 for SUBSCRIBE, 1 for UNSUBSCRIBE contact.
Public propertyActionDefinition
Action definition.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyActionStep
Current step.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyArguments
Action arguments
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyAutomationManager
Automation manager
(Inherited from AutomationAction.)
Public propertyComment
Comment used when action moves to next step.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyInfoObject
Current info object.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyInheritDoubleOptIn
If true, action uses subscribe settings from it's newsletter.
Public propertyInitialStep
Current step.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyMacroResolver
Macro resolver for action.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyManager
Manager.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyNewsletterName
Newsletter identifier.
Public propertyOriginalStep
Current step.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyParameters
Parameters of action.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertySiteName
Site name.
Public propertyStateObject
Current state object.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyUser
User running action.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public propertyWorkflow
Current workflow.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Top
Methods
  NameDescription
Public methodExecute
Executes current action
(Overrides BaseWorkflowActionInfoType, StateInfoType, ActionEnumTypeExecute.)
Protected methodGetDefaultMacroResolver
Gets the default macro resolver.
(Inherited from AutomationAction.)
Protected methodGetResolvedParameterReturnType
Gets resolved value of parameter.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public methodLogMessage
Logs message to event log.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Public methodProcess
Processes action.
(Inherited from BaseWorkflowActionInfoType, StateInfoType, ActionEnumType.)
Protected methodRefreshObject
Refreshes object instance
(Inherited from AutomationAction.)
Top
See Also