Click or drag to resize
SubscriberNewsletterInfoProvider Class
Class providing SubscriberNewsletterInfo management.
Inheritance Hierarchy
SystemObject
  CMS.DataEngineAbstractInfoProviderSubscriberNewsletterInfo, SubscriberNewsletterInfoProvider, ObjectQuerySubscriberNewsletterInfo
    CMS.DataEngineAbstractInfoProviderSubscriberNewsletterInfo, SubscriberNewsletterInfoProvider
      CMS.NewslettersSubscriberNewsletterInfoProvider

Namespace: CMS.Newsletters
Assembly: CMS.Newsletters (in CMS.Newsletters.dll) Version: 13.0.131
Syntax
C#
public class SubscriberNewsletterInfoProvider : AbstractInfoProvider<SubscriberNewsletterInfo, SubscriberNewsletterInfoProvider>, 
	ISubscriberNewsletterInfoProvider, IInfoProvider<SubscriberNewsletterInfo>, IInfoByIdProvider<SubscriberNewsletterInfo>

The SubscriberNewsletterInfoProvider type exposes the following members.

Constructors
  NameDescription
Public methodSubscriberNewsletterInfoProvider
Top
Fields
Properties
Methods
  NameDescription
Public methodAdd
Creates SubscriberNewsletterInfo binding.
Public methodStatic memberAddSubscriberToNewsletter Obsolete.
Adds specified subscriber to the newsletter.
Protected methodAddSubscriberToNewsletterInternal Obsolete.
Adds specified subscriber to the newsletter.
Public methodStatic memberApproveSubscription
Approve subscription.
Protected methodApproveSubscriptionInternal
Approves subscription.
Protected methodBeginTransaction
Creates a new transaction over this provider.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkDelete
Bulk deletes info objects based on the given condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkInsertInfos(IEnumerableBaseInfo)
Bulk inserts the given list of info objects
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkInsertInfos(IEnumerableTInfo, BulkInsertSettings)
Bulk inserts the given list of info objects.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCheckUniqueCodeName
Checks if the object has unique code name. Returns true if the object has unique code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCheckUniqueValues
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 AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodClearHashtables
Clears the object's hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodCreateDefaultBulkInsertSettings
Creates bulk insert settings. By default CheckConstraints and TableLock flags are set.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodCreateInfo
Creates a new info object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCreateWebFarmTask(String, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCreateWebFarmTask(String, String, Byte, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodDelete
Deletes the info object from the underlying data store.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodDeleteInfo
Deletes the object to the database.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodDeleteObjectFromHashtables
Deletes the object instance from the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberDeleteSubscriberNewsletterInfo(SubscriberNewsletterInfo) Obsolete.
Deletes specified SubscriberNewsletterInfo.
Public methodStatic memberDeleteSubscriberNewsletterInfo(Int32, Int32) Obsolete.
Deletes SubscriberNewsletterInfo specified by subscriberID and newsletterID.
Public methodStatic memberDeleteSubscriberNewsletterInfos
Deletes SubscriberNewsletterInfo objects based on specified where condition.
Protected methodDeleteSubscriberNewsletterInfosInternal
Deletes SubscriberNewsletterInfo objects based on specified where condition.
Public methodGet
Gets the object query for TInfo retrieval.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(Guid)
Gets an instance of info object based on its GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(Int32)
Gets an instance of info object based on its ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(String)
Gets an instance of info object based on its code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(Guid, Int32)
Gets an instance of info object based on its GUID and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(String, Int32)
Gets an instance of info object based on its code name and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(Int32, Int32)
Gets an instance of the SubscriberNewsletterInfo binding structure.
Public methodStatic memberGetApprovedSubscriberNewsletters
Returns a query for all approved SubscriberNewsletterInfo objects.
Protected methodGetApprovedSubscriberNewslettersInternal
Returns a query for all approved SubscriberNewsletterInfo objects.
Public methodGetAsync(Guid, NullableCancellationToken)
Asynchronously gets an instance of info object based on its GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(Int32, NullableCancellationToken)
Asynchronously gets an instance of info object based on its ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(String, NullableCancellationToken)
Asynchronously gets an instance of info object based on its code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(Guid, Int32, NullableCancellationToken)
Asynchronously gets an instance of info object based on its GUID and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(String, Int32, NullableCancellationToken)
Asynchronously gets an instance of info object based on its code name and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(Int32, Int32, NullableCancellationToken)
Asynchronously gets an instance of the SubscriberNewsletterInfo binding structure.
Protected methodGetDeleteQuery
Gets the object query that deletes all items matching the query parameters
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Boolean, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeNameAsync(String, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeNameAsync(String, Int32, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByFullName
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuid(Guid, Boolean)
Gets an instance of info object based on the given GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuid(Guid, Int32, Boolean)
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuidAsync(Guid, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuidAsync(Guid, Int32, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoById
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByIdAsync
Asynchronously gets an instance of info object based on ID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfosByIds
Gets the list of info objects by their IDs.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetNewsletterSubscribersIds
Returns subscribers IDs for a specified newsletter.
Protected methodGetObjectQuery
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetObjectQueryInternal
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodStatic memberGetSubscriberNewsletterInfo(String)
Returns the SubscriberNewsletterInfo structure for the specified subscription hash.
Public methodStatic memberGetSubscriberNewsletterInfo(Int32, Int32) Obsolete.
Returns the SubscriberNewsletterInfo structure for the specified subscriberID and newsletterID.
Protected methodGetSubscriberNewsletterInfoInternal(String)
Returns the SubscriberNewsletterInfo structure for the specified subscriptionHash.
Protected methodGetSubscriberNewsletterInfoInternal(Int32, Int32) Obsolete.
Returns SubscriberNewsletterInfo with specified ID.
Public methodStatic memberGetSubscriberNewsletters Obsolete.
Returns a query for all the SubscriberNewsletterInfo objects.
Protected methodGetSubscribersIdsFromViewInternal
Returns subscribers IDs for a specified newsletter.
Public methodStatic memberGetSubscriptions
Returns all existing subscriptions along with detailed information about the subscriber.
Public methodStatic memberGetSubscriptionsByType
Returns DataSet with subscribers by type for specified issue(newsletter).
Protected methodGetSubscriptionsByTypeInternal
Returns DataSet with subscribers by type for specified issue(newsletter).
Protected methodInit
Initializes the provider with the given type info and hashtable settings
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodInitHashtableSettings
Initializes the HashtableSettings based on typeInfo and using settings as default values.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodInitTypeInfoAndRegister
Initializes the provider variables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodInvalidate
Sets this provider as invalid
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodLoadAllInfos
Loads all infos to the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodLoadInfos
Loads all objects from the database to memory.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodProcessWebFarmTask
Runs the processing of specific web farm task for current provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodProcessWebFarmTaskInternal
Runs the processing of specific web farm task for current provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodRegisterObjectInHashtables
Registers the object instance within the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberRejectSubscription
Reject subscription.
Protected methodRejectSubscriptionInternal
Rejects subscription.
Public methodRemove
Deletes SubscriberNewsletterInfo binding.
Protected methodRemoveOriginalCodeNameFromHashtable
Removes the original object code name from the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberRemoveSubscriberFromNewsletter
Removes specified subscriber from newsletter.
Public methodSet
Inserts or updates the info object in the underlying data store.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodStatic memberSetApprovalStatus
Set status of subscriber approval.
Public methodSetAsDefaultProvider

Sets this provider instance as the default provider.

Since the providers are managed by IoC container, setting the provider instance must be performed before the IoC container initialization finishes (i.e. during application pre-initialization).

(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodSetInfo
Inserts or Updates the object to the database.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberSetSubscriberNewsletterInfo Obsolete.
Sets (updates or inserts) specified SubscriberNewsletterInfo.
Protected methodUpdateData(String, QueryDataParameters, String)
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodUpdateData(IWhereCondition, IEnumerableKeyValuePairString, Object, Boolean)
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodUpdateObjectInHashtables
Updates the object instance in the hashtables. Update is different than RegisterObjectInHashtables(TInfo), because it logs task about changing object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodValidateCodeName
Validates the object code name. Returns true if the code name is valid.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Top
See Also