Click or drag to resize
ForumInfoProvider Class
Class providing ForumInfo management.
Inheritance Hierarchy
SystemObject
  CMS.DataEngineAbstractInfoProviderForumInfo, ForumInfoProvider, ObjectQueryForumInfo
    CMS.DataEngineAbstractInfoProviderForumInfo, ForumInfoProvider
      CMS.ForumsForumInfoProvider

Namespace: CMS.Forums
Assembly: CMS.Forums (in CMS.Forums.dll) Version: 11.0.0
Syntax
C#
public class ForumInfoProvider : AbstractInfoProvider<ForumInfo, ForumInfoProvider>

The ForumInfoProvider type exposes the following members.

Constructors
  NameDescription
Public methodForumInfoProvider
Constructor
Top
Fields
Properties
Methods
  NameDescription
Public methodStatic memberAddModerator
Add moderator to forum, return moderator Id.
Public methodStatic memberAddRoleToForum
Adds specified role to the forum.
Public methodAddSiteWhereCondition Obsolete.
Creates site where condition from the specified parameters and adds it to the original where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
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 methodStatic memberCheckLicense
Checks the license.
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.)
Public methodStatic memberClearLicCheck
Clear license limitations table.
Public methodStatic memberCombineSecurityWhereCondition
Add security where condition to the existing where condition.
Protected methodCombineSecurityWhereConditionInternal
Add security where condition to the existing where condition.
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 methodStatic memberDeleteForumInfo(Int32)
Deletes specified forum.
Public methodStatic memberDeleteForumInfo(ForumInfo)
Deletes specified forum.
Protected methodDeleteInfo
Deletes the object to the database.
(Overrides AbstractInfoProviderTInfo, TProvider, TQueryDeleteInfo(TInfo).)
Protected methodDeleteObjectFromHashtables
Deletes the object instance from the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetAllForums Obsolete.
Returns all forums.
Public methodStatic memberGetAllForums(String, String) Obsolete.
Returns all forums according to the specified conditions.
Protected methodGetDeleteQuery
Gets the object query that deletes all items matching the query parameters
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetForumIdsByForumName
Returns IDs of forums with specified name.
Public methodStatic memberGetForumInfo(Int32)
Returns the ForumInfo structure for the specified forum.
Public methodStatic memberGetForumInfo(String, Int32)
Returns the ForumInfo structure for the specified forum.
Public methodStatic memberGetForumInfo(String, Int32, Int32)
Returns the ForumInfo structure for the specified forum.
Public methodStatic memberGetForumInfoByDocument
Returns the ForumInfo structure for the specified document.
Protected methodGetForumInfoByDocumentInternal
Returns the ForumInfo structure for the specified document.
Public methodStatic memberGetForumInfoByGUID
Returns object with specified GUID.
Public methodStatic memberGetForums
Returns a query for all the ForumInfo objects.
Public methodStatic memberGetForums(String, String, Int32, String) Obsolete.
Returns forums according to the specified conditions.
Public methodStatic memberGetForumsByGroupID(Int32) Obsolete.
Returns DataSet with all forums which are assigned to group id.
Public methodStatic memberGetForumsByGroupID(Int32, Boolean) Obsolete.
Returns DataSet with all forums which are assigned to group id.
Public methodStatic memberGetForumsCount
Returns the number of message boards related to the specified document.
Protected methodGetForumsCountInternal
Returns the number of message boards related to the specified document.
Protected methodGetForumsInternal Obsolete.
Returns forums according to the specified conditions.
Public methodStatic memberGetForumSiteName
Returns site name with dependence on selected forum id.
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 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 methodGetInfoById
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 memberGetModerator
Returns forum id's to moderator assigned by user id.
Protected methodGetModeratorInternal
Returns forum id's to moderator assigned by user id.
Public methodStatic memberGetModerators
Returns DataSet with moderators(User) to specified forum.
Protected methodGetModeratorsInternal
Returns DataSet with moderators(User) to specified forum.
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 memberGetRoleNamesForForum Obsolete.
Returns RoleNames in format rolename1;rolename2;rolename3....
Protected methodGetRoleNamesForForumInternal
Returns RoleNames in format rolename1;rolename2;rolename3....
Public methodStatic memberGetSearchDocuments
Returns search documents
Protected methodGetSingleObject Obsolete.
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodGetSiteWhereCondition Obsolete.
Gets the where condition to limit the objects to specific site.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
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.)
Public methodStatic memberIsAuthorizedPerForum
Indicates whether specified user has assigned specific permission for the specified forum.
Protected methodIsAuthorizedPerForumInternal
Indicates whether specified user has assigned specific permission for the specified forum.
Public methodStatic memberIsRoleAllowedForForum
Returns true if role is allowed for given forum.
Protected methodIsRoleAllowedForForumInternal
Returns true if role is allowed for given forum.
Public methodStatic memberLicenseVersionCheck
License version check.
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 methodStatic memberMoveForumDown
Moves forum down in the order sequence (down = larger ForumpOrder = later in the navigation).
Protected methodMoveForumDownInternal
Moves forum down in the order sequence (down = larger ForumpOrder = later in the navigation).
Public methodStatic memberMoveForumUp
Moves forum up in the order sequence (up = smaller ForumOrder = sooner in the navigation).
Protected methodMoveForumUpInternal
Moves forum up in the order sequence (up = smaller ForumOrder = sooner in the navigation).
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.)
Public methodStatic memberRefreshDataCount
Refresh threads and posts count.
Protected methodRegisterObjectInHashtables
Registers the object instance within the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberRemoveModerator
Remove moderator from forum id.
Protected methodRemoveOriginalCodeNameFromHashtable
Removes the original object code name from the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberRemoveRoleFromForum
Removes the forum role assignment.
Public methodSetAsDefaultProvider
Sets this provider instance as the default provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberSetForumInfo
Sets (updates or inserts) specified forum.
Protected methodSetInfo
Inserts or Updates the object to the database.
(Overrides AbstractInfoProviderTInfo, TProvider, TQuerySetInfo(TInfo).)
Public methodSortAlphabetically Obsolete.
Sorts the object alphabetically.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
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 methodUpdateForumCountsInternal
Update threads, posts, last user and last time values.
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.)
Protected methodUpdateQuestionSolvedInternal
Updates PostQuestionSolved field in threads. Sets true in threads where at least one post is marked as is answer (according to the forum AnswerLimit settings).
Public methodValidateCodeName
Validates the object code name. Returns true if the code name is valid.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Top
See Also