SubscriberNewsletterInfoProvider Class

Class providing SubscriberNewsletterInfo management.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractInfoProvider<SubscriberNewsletterInfo, SubscriberNewsletterInfoProvider, ObjectQuery<SubscriberNewsletterInfo>>
    CMS.DataEngine.AbstractInfoProvider<SubscriberNewsletterInfo, SubscriberNewsletterInfoProvider>
      CMS.Newsletters.SubscriberNewsletterInfoProvider

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

Syntax

public class SubscriberNewsletterInfoProvider : AbstractInfoProvider<SubscriberNewsletterInfo, SubscriberNewsletterInfoProvider>

The SubscriberNewsletterInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	SubscriberNewsletterInfoProvider

Fields

	Name	Description
Protected field	infos	Info tables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)

Properties

	Name	Description
Public property	DataSource	Data source for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	HashtableSettings	Gets hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected property	InfoObject	Info object instance the provider is working with. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	IsValid	Indicates if the provider instance is up-to-date and can be used to manage object instances. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	TypeInfo	Object type information. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)

Methods

	Name	Description
Public method Static member	AddSubscriberToNewsletter(Int32, Int32, DateTime)	Obsolete. Adds specified subscriber to the newsletter.
Public method Static member	AddSubscriberToNewsletter(Int32, Int32, DateTime, Boolean)	Adds specified subscriber to the newsletter.
Protected method	AddSubscriberToNewsletterInternal	Adds specified subscriber to the newsletter.
Public method Static member	ApproveSubscription	Approve subscription.
Protected method	ApproveSubscriptionInternal	Approves subscription.
Protected method	BeginTransaction	Creates a new transaction over this provider. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkDelete	Bulk deletes info objects based on the given condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<BaseInfo>)	Bulk inserts the given list of info objects (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<TInfo>, BulkInsertSettings)	Bulk inserts the given list of info objects. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CheckUniqueCodeName	Checks if the object has unique code name. Returns true if the object has unique code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CheckUniqueValues	Checks if a record with the same column values already exists in the database. Returns true if the set of values is unique. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	ClearHashtables	Clears the object's hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	CreateDefaultBulkInsertSettings	Creates bulk insert settings. By default CheckConstraints and TableLock flags are set. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	CreateInfo	Creates a new info object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CreateWebFarmTask(String, String)	Creates web farm task specific for current object and action name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CreateWebFarmTask(String, String, Byte[], String)	Creates web farm task specific for current object and action name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	DeleteInfo	Deletes the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	DeleteObjectFromHashtables	Deletes the object instance from the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	DeleteSubscriberNewsletterInfo(SubscriberNewsletterInfo)	Deletes specified SubscriberNewsletterInfo.
Public method Static member	DeleteSubscriberNewsletterInfo(Int32, Int32)	Deletes SubscriberNewsletterInfo specified by subscriberID and newsletterID.
Public method Static member	DeleteSubscriberNewsletterInfos	Deletes SubscriberNewsletterInfo objects based on specified where condition.
Protected method	DeleteSubscriberNewsletterInfosInternal	Deletes SubscriberNewsletterInfo objects based on specified where condition.
Public method Static member	GetApprovedSubscriberNewsletters	Returns a query for all approved SubscriberNewsletterInfo objects.
Protected method	GetApprovedSubscriberNewslettersInternal	Returns a query for all approved SubscriberNewsletterInfo objects.
Protected method	GetDeleteQuery	Gets the object query that deletes all items matching the query parameters (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByFullName	Gets an instance of info object based on the given full name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Boolean)	Gets an instance of info object based on the given GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Int32, Boolean)	Gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoById	Gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfosByIds	Gets the list of info objects by their IDs. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetNewsletterSubscribersIds	Returns subscribers IDs for a specified newsletter.
Protected method	GetObjectQuery	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetObjectQueryInternal	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method Static member	GetSubscriberNewsletterInfo(String)	Returns the SubscriberNewsletterInfo structure for the specified subscription hash.
Public method Static member	GetSubscriberNewsletterInfo(Int32, Int32)	Returns the SubscriberNewsletterInfo structure for the specified subscriberID and newsletterID.
Protected method	GetSubscriberNewsletterInfoInternal(String)	Returns the SubscriberNewsletterInfo structure for the specified subscriptionHash.
Protected method	GetSubscriberNewsletterInfoInternal(Int32, Int32)	Returns SubscriberNewsletterInfo with specified ID.
Public method Static member	GetSubscriberNewsletters	Returns a query for all the SubscriberNewsletterInfo objects.
Protected method	GetSubscribersIdsFromViewInternal	Returns subscribers IDs for a specified newsletter.
Public method Static member	GetSubscriptions	Returns all existing subscriptions along with detailed information about the subscriber.
Public method Static member	GetSubscriptionsByType	Returns DataSet with subscribers by type for specified issue(newsletter).
Protected method	GetSubscriptionsByTypeInternal	Returns DataSet with subscribers by type for specified issue(newsletter).
Protected method	Init	Initializes the provider with the given type info and hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	InitHashtableSettings	Initializes the HashtableSettings based on typeInfo and using settings as default values. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	InitTypeInfoAndRegister	Initializes the provider variables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Invalidate	Sets this provider as invalid (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	LoadAllInfos	Loads all infos to the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	LoadInfos	Loads all objects from the database to memory. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	ProcessWebFarmTask	Runs the processing of specific web farm task for current provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	ProcessWebFarmTaskInternal	Runs the processing of specific web farm task for current provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	RegisterObjectInHashtables	Registers the object instance within the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	RejectSubscription	Reject subscription.
Protected method	RejectSubscriptionInternal	Rejects subscription.
Protected method	RemoveOriginalCodeNameFromHashtable	Removes the original object code name from the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	RemoveSubscriberFromNewsletter	Removes specified subscriber from newsletter.
Public method Static member	SetApprovalStatus	Set status of subscriber approval.
Public method	SetAsDefaultProvider	Sets this provider instance as the default provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	SetInfo	Inserts or Updates the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	SetSubscriberNewsletterInfo	Sets (updates or inserts) specified SubscriberNewsletterInfo.
Protected method	UpdateData(String, QueryDataParameters, String)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateData(IWhereCondition, IEnumerable<KeyValuePair<String, Object>>, Boolean)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateObjectInHashtables	Updates the object instance in the hashtables. Update is different than RegisterObjectInHashtables(TInfo), because it logs task about changing object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	ValidateCodeName	Validates the object code name. Returns true if the code name is valid. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)