MessageInfoProvider Class

Class providing MessageInfo management.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractInfoProvider<MessageInfo, MessageInfoProvider, ObjectQuery<MessageInfo>>
    CMS.DataEngine.AbstractInfoProvider<MessageInfo, MessageInfoProvider>
      CMS.Messaging.MessageInfoProvider

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

Syntax

public class MessageInfoProvider : AbstractInfoProvider<MessageInfo, MessageInfoProvider>

The MessageInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	MessageInfoProvider

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	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>.)
Protected method	DeleteInfo	Deletes the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	DeleteMessageInfo(Int32)	Deletes specified message.
Public method Static member	DeleteMessageInfo(MessageInfo)	Deletes specified message.
Protected method	DeleteObjectFromHashtables	Deletes the object instance from the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	DeleteReceivedMessage	Delete received message - internally uses DeleteMessageInfo.
Public method Static member	DeleteReceivedMessages(Int32)	Delete all user's received messages.
Public method Static member	DeleteReceivedMessages(Int32, String)	Delete all user's received messages.
Protected method	DeleteReceivedMessagesInternal	Delete all user's received messages.
Public method Static member	DeleteSentMessage	Delete sent message - internally uses DeleteMessageInfo.
Public method Static member	DeleteSentMessages(Int32)	Delete all user's sent messages.
Public method Static member	DeleteSentMessages(Int32, String)	Delete all user's sent messages.
Protected method	DeleteSentMessagesInternal	Delete all user's sent messages.
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	GetMessageInfo	Returns the MessageInfo structure for the specified message.
Public method Static member	GetMessageInfoByGUID	Returns object with specified GUID.
Public method Static member	GetMessages(Int32, String)	Gets user's messages - uses general method.
Public method Static member	GetMessages(String, String)	Gets messages - general method.
Public method Static member	GetMessages(Int32, String, Int32, String)	Gets user's messages - uses general method.
Public method Static member	GetMessages(String, String, Int32, String)	Gets messages - general method.
Public method Static member	GetMessagesCount(Int32)	Gets messages count.
Public method Static member	GetMessagesCount(String)	Gets messages count.
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	GetSentMessages(Int32, String)	Gets user's sent messages - uses general method.
Public method Static member	GetSentMessages(Int32, String, Int32, String)	Gets user's sent messages - uses general method.
Public method Static member	GetSentMessagesCount	Gets sent messages count.
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>.)
Public method Static member	GetUnreadMessages(Int32, String)	Gets user's unread messages - uses general method.
Public method Static member	GetUnreadMessages(Int32, String, Int32, String)	Gets user's unread messages - uses general method.
Public method Static member	GetUnreadMessagesCount	Gets messages count.
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 Static member	MarkReadReceivedMessages	Mark user's received messages as read.
Public method Static member	MarkUnreadReceivedMessages	Mark user's received messages as unread.
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	SendNotificationEmail	Send notification email.
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	SetMessageInfo	Sets (updates or inserts) specified message.
Public method	SortAlphabetically	Obsolete. Sorts the object alphabetically. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
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>.)