IssueHelper Class

Issue helper class.

Inheritance Hierarchy

System.Object
  CMS.Base.CoreMethods
    CMS.Base.AbstractHelper
      CMS.Base.AbstractHelper<IssueHelper>
        CMS.Newsletters.IssueHelper

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

Syntax

public class IssueHelper : AbstractHelper<IssueHelper>

The IssueHelper type exposes the following members.

Constructors

	Name	Description
Public method	IssueHelper()	Issue helper that internally uses registered ISubscriberEmailRetriever service.
Public method	IssueHelper(ISubscriberEmailRetriever)	Constructor.

Properties

	Name	Description
Public property	Resolver	Macro resolver.

Methods

	Name	Description
Public method Static member	CopyIssueProperties	Copies specified properties from source issue to target issue.
Public method Static member	GetActivationPage	Retrieves activation page for a specified newsletter.
Protected method	GetActivationPageInternal	Retrieves activation page for a specified newsletter.
Public method Static member	GetBaseUrl	Creates a base URL for prefixing links in the given newsletter's issues.
Protected method	GetBaseUrlInternal	Creates a base URL for prefixing links in the given newsletter's issues.
Public method Static member	GetBreadcrumbsData	Prepares JSON object to be inserted to the breadcrumbs. On some pages the breadcrumbs needs to be hard-coded in order to be able to access single email via link and ensure consistency of breadcrumbs.
Public method Static member	GetContentXML	Returns content of editable regions as XML.
Public method Static member	GetIssueTotalUniqueClicks	Returns number of unique clicks of all issue's links.
Public method Static member	GetIssueVariants(Int32, String)	Returns issue variants for specified issue ID if any.
Public method Static member	GetIssueVariants(IssueInfo, String)	Returns issue variants for specified issue if any.
Public method Static member	GetStatusFriendlyName	Returns issue status friendly name.
Public method Static member	GetUnsubscriptionPage	Retrieves unsubscription page for a specified newsletter.
Protected method	GetUnsubscriptionPageInternal	Retrieves unsubscription page for a specified newsletter.
Public method Static member	GetWinnerIssue	Returns A/B test winner.
Public method	LoadDynamicFields	Loads values of dynamic fields into hashtable.
Public method	LoadRegionsContents(String)	Loads values of editable regions into hashtable.
Public method Static member	LoadRegionsContents(Hashtable, String)	Loads values of editable regions into hashtable.
Public method	ResolveDynamicFieldMacros	Resolves the dynamic field macros, replaces the {%dynamicfieldname%} macro with the dynamic field value.
Public method	ResolveEditableRegionMacros	Resolves the editable region macros, replaces the $$editableregionname:width:height$$ macro with the editable region values previously loaded with LoadRegionsContents method.
Public method	SetAsDefaultHelper	Sets this object as the default helper (Inherited from AbstractHelper<HelperType>.)