| SubscriberInfoProvider Methods |
The SubscriberInfoProvider type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AddSiteWhereCondition(String, Int32, String, Boolean) |
Creates site where condition from the specified parameters and adds it to the original where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| AddSiteWhereCondition(String, Int32, String, Boolean, String) |
Creates site where condition from the specified parameters and adds it to the original where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
 | AddSubscription |
Add subscription to the binding table.
|
| ApproveSubscription(Int32, Int32, Boolean) |
Approves existing subscription - sets SubscriptionApproved to true and SubscriptionApprovedWhen to current time.
Checks if subscription wasn't already approved. Confirmation e-mail may be sent optionally.
|
| ApproveSubscription(String, Boolean, String, DateTime) |
Approves existing subscription - sets SubscriptionApproved to true and SubscriptionApprovedWhen to current time.
Checks if subscription wasn't already approved. Confirmation e-mail may be sent optionally.
|
| BlockContact |
Blocks a contact with specified ID (for contact group subscribers).
|
| BlockSubscriber |
Blocks a subscriber with a specified ID.
|
| BlockUser |
Blocks a user with a specified ID (for role subscribers).
|
 | BoundGetInfoByGuid(Guid) |
Gets the info object by its GUID
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| BoundGetInfoByGuid(Guid, Int32) |
Gets the info object by its GUID and site ID
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| BoundGetInfoById |
Gets the info by ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| BoundGetInfoByName(String) |
Gets the info object by its code name
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| BoundGetInfoByName(String, Int32) |
Gets the info object by its code name and site Id
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| BoundGetInfosByIds |
Gets the list of info objects by their IDs
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| ClearHashtables |
Clear hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| CreateHashtables |
Creates the provider hashtables
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| CreateInfo(Int32) |
Creates an instance of info object.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| CreateInfo(DataRow, Boolean) |
Creates a new info object.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| CreateWebFarmTask(String, String) |
Creates web farm task specific for current object and action name
(Inherited from AbstractProvider.) |
| CreateWebFarmTask(String, String, Byte) |
Creates web farm task specific for current object and action name
(Inherited from AbstractProvider.) |
| DeleteContactSubscribers |
Deletes contact subscribers based on contact IDs.
|
| DeleteContactSubscribersInternal |
Deletes contact subscribers based on contact IDs.
|
| DeleteData(String) |
Deletes the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| DeleteData(IWhereCondition) |
Deletes the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| DeleteData(ActionObjectQueryTInfo) |
Deletes the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| DeleteInfo |
Deletes the object to the database.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| DeleteObjectFromHashtables |
Deletes the object instance from the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| DeleteSubscriberInfo(Int32) |
Deletes specified subscriber.
|
| DeleteSubscriberInfo(SubscriberInfo) |
Deletes specified subscriber.
|
| DeleteSubscriberInfoInternal |
Deletes specified subscriber.
|
| DeleteSubscriberInfos |
Deletes SubscriberInfo objects with dependencies based on specified subscriber IDs.
|
| DeleteSubscriberInfosInternal |
Deletes SubscriberInfo objects with dependencies based on specified subscriber IDs.
|
| DeleteSubscribers(Object) |
Delete given subscribers. Used for asynchronous control.
|
| DeleteSubscribers(String, Int32, Guid, Hashtable) |
Delete given subscribers.
|
| DeleteSubscription |
Deletes subscription from the newsletter.
|
| EmailExists |
Returns true if given e-mail address is already used by any subscriber.
|
| EmailExistsInternal |
Returns true if given e-mail address is already used by any subscriber.
|
| ExportSubscribersFromSite(ListInt32, Int32, Boolean) |
Export subscribers from specified newsletters.
|
| ExportSubscribersFromSite(ListInt32, Int32, Boolean, Int32) |
Export subscribers from specified newsletters.
|
| ExportSubscribersFromSiteInternal |
Export subscribers from specified newsletters.
|
| GetBindingWhereCondition(String, Int32) |
Gets the where condition to limit the objects to specific binding dependency. Use this method only for 2-keys bindings.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetBindingWhereCondition(String, Object) |
Gets the where condition to limit the objects to specific binding dependencies. Use this method for 3 and more-keys bindings.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetCacheDependency(DataSet, String, String) |
Gets the cache dependency for the given object.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetCacheDependency(BaseInfo, String, String) |
Gets the cache dependency for the given object.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetCountInternal |
Gets the number of items matching the given parameters. Does not check the license when retrieving data.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32) |
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32, Int32, Int32, Int32) |
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetDataByColumnT |
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetDataByGuidColumn |
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetDataByIntColumn |
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetDataByStringColumn |
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetDeleteQuery |
Gets the object query that deletes all items matching the query parameters
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetDependencyCacheKeys(DataSet, String, String) |
Gets the cache dependency keys for the given DataSet.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetDependencyCacheKeys(GeneralizedInfo, String, String) |
Gets the cache dependency keys for the given object.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetEmptyDataSet |
Gets the empty data set to be filled by the data
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetExistingIDsInternal |
Filters out all object IDs that do not exist in the database.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetFullNameDictionary |
Creates new dictionary for caching the objects by full name
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetFullNameWhereCondition |
Gets the where condition that searches the object based on the given full name
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetInfo(IWhereCondition) |
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetInfo(ActionObjectQueryTInfo) |
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetInfo(String, String) |
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetInfoByCodeName(String) |
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetInfoByCodeName(String, Boolean) |
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetInfoByCodeName(String, Int32) |
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetInfoByCodeName(String, Int32, Boolean) |
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetInfoByCodeName(String, Int32, Int32) |
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetInfoByCodeName(String, Int32, Boolean, Boolean) |
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetInfoByCodeName(String, Int32, Int32, Boolean) |
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetInfoByCodeNameFromDB |
Gets an instance of info object based on the given code name from database
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetInfoByFullName(String) |
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetInfoByFullName(String, Boolean) |
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetInfoByFullNameInternal |
Gets the info by its full name from the database
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetInfoByGuid(Guid) |
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetInfoByGuid(Guid, Boolean) |
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetInfoByGuid(Guid, Int32) |
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetInfoByGuid(Guid, Int32, Boolean) |
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetInfoByGuidColumn |
Gets an instance of info object based on the string column value.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetInfoByGuidFromDB |
Gets an instance of info object based on the given GUID from database
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetInfoById(Int32) |
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetInfoById(Int32, Boolean) |
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetInfoByIntColumn |
Gets an instance of info object based on the integer column value.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetInfoByStringColumn |
Gets an instance of info object based on the string column value.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetInfosByIds |
Gets the list of info objects by their IDs
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetObjectQuery |
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetObjectQueryInternal |
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetParentWhereCondition |
Gets the where condition to limit the objects to specific parent.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetSingleObject |
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetSiteWhereCondition(Int32) |
Gets the where condition to limit the objects to specific site.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetSiteWhereCondition(Int32, Boolean) |
Gets the where condition to limit the objects to specific site.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| GetSubscriberByEmail |
Returns the Subscriber object for the specified subscriber.
Includes role, user and contact subscriber types as well.
|
| GetSubscriberInfo(Int32) |
Returns the Subscriber object for the specified subscriber.
|
| GetSubscriberInfo(Guid, Int32) |
Returns the Subscriber object for the specified subscriber.
|
| GetSubscriberInfo(String, Int32) |
Returns the Subscriber object for the specified subscriber.
Excludes specific subscriber types such as users, roles, contacts, contact groups or personas.
|
| GetSubscriberInfo(String, Int32, Int32) |
Returns the Subscriber object for the specified subscriber.
|
| GetSubscriberInfoInternal(Int32) |
Returns the Subscriber object for the specified subscriber.
|
| GetSubscriberInfoInternal(Guid, Int32) |
Returns the Subscriber object for the specified subscriber.
|
| GetSubscriberInfoInternal(String, Int32) |
Returns the Subscriber object for the specified subscriber.
Excludes specific subscriber types such as users, roles, contacts, contact groups or personas.
|
| GetSubscriberInfoInternal(String, Int32, Int32) |
Returns the Subscriber object for the specified subscriber.
|
| GetSubscribers |
Returns a query for all the SubscriberInfo objects.
|
| GetSubscribers(SubscriberInfo, Int32, Int32, Int32) |
Gets the list of subscriber's members.
Subscriber member has SubscriberID=0.
|
| GetSubscribersFromView |
Returns subscriber information along with the related user data.
Includes role, user and contact subscriber types as well.
|
| GetSubscribersFromView(String, Int32) |
Returns subscriber information for a specified email and site along with the related user data.
Includes role, user and contact subscriber types as well.
|
| GetSubscribersFromViewInternal |
Returns subscriber information along with the related user data.
|
| GetSubscribersFromViewInternal(String, Int32) |
Returns subscriber information for a specified email and site along with the related user data.
Includes role, user and contact subscriber types as well.
|
| GetSubscribersInternal |
Returns a query for all the SubscriberInfo objects.
|
| GetTypeInfo |
Gets the type info for this provider
(Inherited from BaseAbstractInfoProvider.) |
| CheckLicense |
Checks the license.
|
| CheckUniqueCodeName |
Checks if the object has unique code name. Returns true if the object has unique code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| 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 AbstractInfoProviderTInfo, TProvider.) |
| Init |
Initializes the provider variables.
(Inherited from BaseAbstractInfoProvider.) |
| InitHashtables |
Initializes the hashtable settings
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| Invalidate |
Sets this provider as invalid
(Inherited from AbstractProvider.) |
| IsSubscribed(Int32, Int32) |
Returns true if subscriber is subscribed to newsletter.
|
| IsSubscribed(Guid, Guid, Int32) |
Returns true if subscriber is subscribed to newsletter.
|
| LicenseVersionCheck(String, FeatureEnum, ObjectActionEnum) |
License version check.
|
| LicenseVersionCheck(String, FeatureEnum, ObjectActionEnum, Boolean) |
License version check.
|
| LoadAllInfos |
Loads all infos to the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| LoadGeneration |
Loads the specified generation of the objects.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| LoadInfos |
Loads all objects from the database to memory.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| LoadObjectsToHashtables |
Loads the objects from a DataSet to the hashtables
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| NewTransaction |
Creates a new transaction over this provider
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| ProcessWebFarmTask |
Runs the processing of specific web farm task for current provider
(Inherited from BaseAbstractInfoProvider.) |
| RecalculateData |
Recalculates the value in the given column using the coefficient.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| RefreshObjectsCounts |
Updates all counts for all sub-objects.
(Inherited from BaseAbstractInfoProvider.) |
| Register |
Registers current provider in providers collection
(Inherited from AbstractProvider.) |
| RegisterObjectInHashtables |
Registers the object instance within the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| RejectSubscription |
Reject subscriber from newsletter.
|
| RemoveOriginalCodeNameFromHashtable |
Removes the original object code name from the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| RenewSubscription |
Renews subscription.
|
| ReplaceData |
Replaces the data in the given columns.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| ResetToDefault |
Resets the provider to default implementation
(Inherited from AbstractInfoProviderTProvider.) |
| SetAsDefaultProvider |
Sets this provider instance as the default provider
(Inherited from AbstractInfoProviderTProvider.) |
| SetInfo |
Inserts or Updates the object to the database.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| SetSubscriberInfo |
Sets (updates or inserts) specified subscriber.
|
| SetSubscriberInfoInternal |
Sets (updates or inserts) specified subscriber.
|
| SortAlphabetically |
Sorts the object alphabetically.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| Subscribe(Guid, Int32, Int32, Boolean) |
Subscribes subscriber to newsletter.
|
| Subscribe(Int32, Int32, DateTime, Boolean, Boolean) |
Subscribes subscriber to newsletter.
|
| SynchronizeSubscriberInfomation |
Renames subscriber specified by subscriberRealtedId on all sites.
Optional parameters are saved to subscriber only when not set to null.
|
| TouchCacheDependencies |
Touches the cache dependencies of the given object.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| UnblockContact |
Unblocks a contact with specified ID (for contact group subscribers).
|
| UnblockSubscriber |
Unblocks a subscriber with a specified ID.
|
| UnblockUser |
Unblocks a user with a specified ID (for role subscribers).
|
| Unsubscribe(SubscriberNewsletterInfo, Boolean) |
Unsubscribes subscriber from newsletter.
|
| Unsubscribe(Int32, Int32, Boolean) |
Unsubscribe the subscriber from the newsletter.
|
| Unsubscribe(Guid, Guid, Int32, Boolean) |
Unsubscribes subscriber from newsletter.
|
| Unsubscribe(String, Boolean, String, DateTime) |
Unsubscribes subscriber from newsletter.
|
| UnsubscribeAll |
Unsubscribes subscriber from all subscribed newsletters.
|
| UnsubscribeFromNewsletters(Object) |
Unsubscribe subscribers from specified newsletters. Used for asynchronous control.
|
| UnsubscribeFromNewsletters(String, ListInt32, Int32, Boolean, Guid, Hashtable) |
Unsubscribe subscribers from specified newsletters.
|
| UpdateData |
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| UpdateObjectInHashtables |
Updates the object instance in the hashtables. Updates is different than register, because it logs task about changing object.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| UseSource(TInfo) |
Sets the provider to use given data as data source
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
| UseSource(DataQuerySource) |
Sets the provider to use given data as data source
(Inherited from BaseAbstractInfoProvider.) |
| ValidateCodeName |
Validates the object code name. Returns true if the code name is valid.
(Inherited from AbstractInfoProviderTInfo, TProvider.) |
Extension Methods| Name | Description | |
|---|---|---|
 | AsValue |
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.) |
| GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
See Also