ContactInfoProvider Class

Class providing ContactInfo management.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractInfoProvider<ContactInfo, ContactInfoProvider, ObjectQuery<ContactInfo>>
    CMS.DataEngine.AbstractInfoProvider<ContactInfo, ContactInfoProvider>
      CMS.ContactManagement.ContactInfoProvider

Namespace: CMS.ContactManagement
Assembly: CMS.ContactManagement (in CMS.ContactManagement.dll) Version: 11.0.0

Syntax

public class ContactInfoProvider : AbstractInfoProvider<ContactInfo, ContactInfoProvider>

The ContactInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	ContactInfoProvider	Constructor which enables weak reference caching by ID and GUID.

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	AddContactBounce	Increments number of bounces by one for specified contact.
Public method Static member	AddContactBounceByEmail	Increments number of bounces by one for all contacts specified by e-mail address across all sites.
Protected method	AddContactBounceByEmailInternal	Increments number of bounces by one for all contacts specified by e-mail address.
Protected method	AddContactBounceInternal	Incerements number of bounces by one for specified contact.
Public method	AddSiteWhereCondition	Obsolete. Creates site where condition from the specified parameters and adds it to the original where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
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>.)
Public method Static member	DeleteContactInfo(Int32)	Deletes contact with specified ID.
Public method Static member	DeleteContactInfo(ContactInfo)	Deletes specified contact.
Public method Static member	DeleteContactInfos	Deletes all infos by stored procedure.
Protected method	DeleteContactInfosInternal	Deletes all contacts by specified ID.
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	GetContactFullName(Int32)	Returns full contact name consisting of first, middle and last name.
Public method Static member	GetContactFullName(ContactInfo)	Returns full contact name consisting of first, middle and last name.
Public method Static member	GetContactIDByEmail	Finds contact for given email address.
Public method Static member	GetContactInfo(Guid)	Returns contact with specified GUID.
Public method Static member	GetContactInfo(Int32)	Returns contact with specified ID.
Public method Static member	GetContactInfo(String)	Returns contact with specified email.
Protected method	GetContactInfoInternal(Guid)	Returns contact with specified GUID.
Protected method	GetContactInfoInternal(Int32)	Returns contact with specified ID.
Protected method	GetContactInfoInternal(String)	Returns contact with specified email.
Public method Static member	GetContacts	Returns a query for all the ContactInfo 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>.)
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>.)
Protected method	GetSingleObject	Obsolete. Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	GetSiteWhereCondition	Obsolete. Gets the where condition to limit the objects to specific site. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
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>.)
Protected method	RemoveOriginalCodeNameFromHashtable	Removes the original object code name from the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	RemovePersonaFromContacts	Removes given persona from contacts. Sets column ContactPersonaID to NULL on contacts where this column equals to given persona ID.
Protected method	RemovePersonaFromContactsInternal	Removes given persona from contacts. Sets column ContactPersonaID to NULL on contacts where this column equals to given persona ID.
Public method Static member	RequireLeadReplication	Marks the specified contact as required for lead replication despite its score.
Protected method	RequireLeadReplicationInternal	Marks the specified contact as required for lead replication despite its score.
Public method	SetAsDefaultProvider	Sets this provider instance as the default provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	SetContactInfo	Sets (updates or inserts) specified contact.
Protected method	SetContactInfoInternal	Sets (updates or inserts) specified contact.
Protected method	SetInfo	Inserts or Updates the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	SortAlphabetically	Obsolete. Sorts the object alphabetically. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	UpdateContactFromExternalData(BaseInfo, Boolean, ContactInfo)	Updates contact information from record submitted through BizForm module - this requires form fields to be mapped to contact.
Public method Static member	UpdateContactFromExternalData(BaseInfo, Boolean, Int32)	Updates contact information from record submitted through BizForm module - this requires form fields to be mapped to contact.
Public method Static member	UpdateContactFromExternalSource	Updates contact information from set of data.
Public method Static member	UpdateContactStatus	Updates contact status ID of specified contacts.
Protected method	UpdateContactStatusInternal	Updates contact status ID of specified contacts.
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>.)
Public method Static member	UpdateLeadReplicationStatus	Updates the specified contact in database with information related to Salesforce lead replication.
Protected method	UpdateLeadReplicationStatusInternal	Updates the specified contact in database with information related to Salesforce lead replication.
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>.)