BoardInfoProvider Class

Class providing BoardInfo management.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractInfoProvider<BoardInfo, BoardInfoProvider, ObjectQuery<BoardInfo>>
    CMS.DataEngine.AbstractInfoProvider<BoardInfo, BoardInfoProvider>
      CMS.MessageBoards.BoardInfoProvider

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

Syntax

public class BoardInfoProvider : AbstractInfoProvider<BoardInfo, BoardInfoProvider>, 
	IFullNameInfoProvider

The BoardInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	BoardInfoProvider	Creates a new instance of BoardInfoProvider.

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>.)
Public method Static member	DeleteBoardInfo(Int32)	Deletes specified board.
Public method Static member	DeleteBoardInfo(BoardInfo)	Deletes specified board.
Protected method	DeleteInfo	Deletes the object to the database. (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.DeleteInfo(TInfo).)
Protected method	DeleteObjectFromHashtables	Deletes the object instance from the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	DoubleOptInInterval	Gets double opt-in interval for the site. It's time interval in hours within which user has to approve her subscription.
Public method Static member	EnableDoubleOptIn	Gets setting value indicating if double opt-in should be enabled.
Public method Static member	GetBoardInfo(Int32)	Returns the BoardInfo structure for the specified board.
Public method Static member	GetBoardInfo(String, Int32)	Returns the BoardInfo structure for the specified board.
Public method Static member	GetBoardInfoForGroup	Returns the info on board matching specified criteria.
Protected method	GetBoardInfoForGroupInternal	Returns the info on board matching specified criteria.
Public method Static member	GetBoardInfoForUser	Returns the info on board matching specified criteria.
Protected method	GetBoardInfoForUserInternal	Returns the info on board matching specified criteria.
Protected method	GetBoardInfoInternal	Returns the BoardInfo structure for the specified board.
Public method Static member	GetBoardOwnerTypeEnum	Returns BoardOwnerType specified by string.
Public method Static member	GetBoardOwnerTypeEnumString	Returns 'USER', 'GROUP' or 'DOCUMENT' (default) string according to given owner type.
Public method Static member	GetBoardsCount	Returns the number of message boards related to the specified document.
Protected method	GetBoardsCountInternal	Returns the number of message boards related to the specified document.
Protected method	GetDeleteQuery	Gets the object query that deletes all items matching the query parameters (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	GetFullNameDictionary	Creates a new dictionary for caching the objects by the full name.
Public method	GetFullNameWhereCondition	Gets the where condition that searches the object based on the given full name.
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	GetMessageBoardName	Returns the name for messageboard according to its type, webpart name, and identifier dependent on type.
Protected method	GetMessageBoardNameInternal	Returns the name for messageboard according to its type, webpart name, and identifier dependent on type.
Public method Static member	GetMessageBoards()	Returns message boards object query.
Public method Static member	GetMessageBoards(String, String, Int32, String, Boolean)	Returns all message boards matching specified criteria with associated document data.
Protected method	GetMessageBoardsInternal	Returns all message boards matching specified criteria with associated document data.
Public method Static member	GetMessageBoardUrl	Returns absolute URL to the document where the message board is placed on.
Protected method	GetMessageBoardUrlInternal	Returns absolute URL to the document where the message board is placed on. Message board object to get document URL of.Site name of the message board.
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>.)
Public method Static member	GetUnsubscriptionUrl	Gets unsubscription page URL.
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>.)
Public method Static member	IsBoardOpened	Determines whether the board is opened for the current user.
Public method Static member	IsUserAuthorizedPerBoard	Checks if the user is authorized per board (if she belongs to the role authorized per board).
Protected method	IsUserAuthorizedPerBoardInternal	Checks if the user is authorized per board (if she belongs to the role authorized per board).
Public method Static member	IsUserAuthorizedToAddMessages(BoardInfo)	Returns True if current user is authorized to add messages to the specified message board, otherwise returns False.
Public method Static member	IsUserAuthorizedToAddMessages(BoardProperties)	Returns True if current user is authorized to add messages to the specified message board, otherwise returns False.
Public method Static member	IsUserAuthorizedToManageMessages	Checks if the current user can manage messages of the specified board.
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	SendOptInConfirmation	Gets setting value indicating if double opt-in confirmation emails should be sent.
Public method	SetAsDefaultProvider	Sets this provider instance as the default provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	SetBoardInfo	Sets (updates or inserts) specified board.
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>.)
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>.)