The DotNetNuke Core Forum module.

Syntax

Visual Basic (Declaration)
Namespace DotNetNuke.Modules.Forum

Classes

  ClassDescription
Public classAdministration
A Control Panel page with links to other forum administrative pages.
Public classAnswerController
Communicates with the data store via the DAL for the Forum_Polls_Answers Answer items.
Public classAnswerInfo
All properties associated with the Forum_Polls_Answers table.
Public classAvatarAdminControl
A re-usable control for handling the various avatar types in the forum module.
Public classAvatars
Page to manage various avatar related settings.
Public classBadWordEdit
Used to Add/Edit a bad word
Public classBadWords
Management screen which includes a grid list of current words to filter for and the ability to enable/disable this throughout the instance of the module.
Public classCleanupEmailQueuedTasks
This is the Email Queue Task handler. It is designed to allow email notifications to be sent using a background thread and to not worry about the ASP.NET default limitation of 25 threads since only one will be spawned to handle this. This is all methods necessary to use the core Scheduler for tasks.
Public classCompareForumPermissions
Compares two sets of forum permission collections.
Public classConfig
This houses all the configuration items for use through this entire module. Most of these are module settings.
Public classContainer
Loads the proper control to display to the end user based on various parameters and settings
Public classContentRemoved
This is a page to handle if a thread was completely deleted. It presents the user w/ an error message and a link back home
Public classDataProvider
The abstract provider class for the Forum module.
Public classDNNForum
This is initialized by the Forum_Container (dispatch).
Public classEmailAdmin
This screen is used to manage the email configuration for this forum module.
Public classEmailQueueTaskController
Permits access to the data store for EmailQueueTask items.
Public classEmailQueueTaskEmailsController
Interacts w/ the data store for the outgoing emails for a task.
Public classEmailQueueTaskEmailsInfo
The EmailQueueTaskEmailsInfo represents an email queue task email item
Public classEmailQueueTaskInfo
The EmailItemInfo represents an Email Queue Task info Item
Public classEmailTemplates
Allows users to manage email templates for a single portal instance
Public classFilterWordCollection
A collection of words to filter for and their replacements.
Public classFilterWordInfo
All properties associated with the Forum_FilterWords Word items.
Public classForumBaseControl
Gets/Sets all the properties we need to use in the various forum views which are loaded via the dispatch (Forum_Container) control.
Public classForumBaseObject
The base object is responsible for common methods used to build the forum UI in vb code including: ForumPost, ForumThread, ForumGroup, ForumThreadSearch, ForumPortalSearch, ForumModerate
Public classForumController
Used to communicate with the data store about Forum specific items.
Public classForumEdit
You can add/edit a forum here. (Management of an individual forum)
Public classForumEmail
Constructs an outgoing email for all types of email communication.
Public classForumEmailDistributionController
Communicates w/ the data store to retrieve a distribution arraylist of recipients for an outgoing email.
Public classForumEmailDistributionInfo
Used for determing who to send an email to.
Public classForumEmailTemplateController
Used to communicate with the data store for access to Email templates.
Public classForumEmailTemplateInfo
An instance of the ForumEmailTemplateInfo object. This object is used for all email templates.
Public classForumInfo
The forum Info object uses caching and handles the population of all data specific to a single forum instance. Rendering for Group view items is also handled here.
Public classForumKeywordController
Connects the business layer to the data layer for forum Keywords (used for template parsing).
Public classForumKeywordInfo
Keyword Info Object is used for retrieving what keywords to parse for based on content type
Public classForumManage
From this page you can re-order forums and groups, navigate to edit/add forums/groups.
Public classForumObject
Creates an instance of the forum object and reads properties critical to its operation.
Public classForumPermissionCollection
Basically a copy of the core ModulePermissionCollection.
Public classForumPermissionController
Basically a copy of ModulePermissionController. This allows the forum module ot implement permissions on a per module basis overriding module permissions. (Only in the sense of further restriction, not less)
Public classForumPermissionInfo
Basically a copy of the core ModulePermissionInfo class.
Public classForumPMReadsController
A Forum PM Read Controller populates the corresponding Info object.
Public classForumPMReadsInfo
A Forum Private Message Read Info object is used to determine if a user has read a PM or not.
Public classForumPreConfig
Runs only when a forum module is first placed on a page to set configuration defaults and to create a new forum group and a new default forum so user can use immediately
Public classForums
This object is used in the same way as Groups, Threads, etc w/ the exception that it has no UI to render this logic in.
Public classForumTemplateController
Forum Template Controller - These are DeletePost, MoveThread, etc.
Public classForumTemplateInfo
An instance of the ForumTemplateInfo object. This object is used for all non-email templates.
Public classForumText
This class formats the content of forum posts and the notification emails.
Public classForumTreeview
Used to build the DNNTree in User Settings, Search views.
Public classForumUser
Everything necessary for a Forum User, all based on PortalID. This means a forum user profile is specific to a portal instance.
Public classForumUserController
Connector to the data layer for the forum user object
Public classGroupController
CRUD (and all db methods) Group database methods
Public classGroupEdit
From this page the user can add or edit a group.
Public classGroupInfo
A single instance of the GroupInfo Object.
Public classGroups
This is the initial view seen by the forums module. (Group View) All rendering is done in code to create UI and done or called from this class.
Public classHostEmailAdmin
This screen is used to manage the email configuration queue cleanup This can only be adjusted by SuperUsers
Public classMemberList
This is a member listing directory. Only users who permit their listing are shown here. This is a central spot for PM as well as searching to find other forum users.
Public classModerate
This renders the moderator queue screen
Public classModerateController
Handles all database calls for moderator auditing and for tasks specific to a moderator This does not include post moderation actions where posts are actually approved/rejected, etc. just the auditing of those functions (database tracking)
Public classModerateForumInfo
Info class is used to replicate forum info class but also has ability to render UI for part of Posts to moderate queue.
Public classModuleSecurity
The central class where all non-core security related checks should be done against.
Public classModuleSettings
The Settings ModuleSettingsBase is used to manage the settings for the Forum Module. You only store settings here that you want to allow to be changeable at the page level. This means you can copy existing versions of the module based on (ModuleID) and display things different based on the page settings for this ModuleID.
Public classPermissionInfo
Basically a copy of core PermissionInfo
Public classPMAdd
This is where all posts are added and/or edited from. It also fires off email notification and factors in moderation.
Public classPMController
Communicates with the Forum_PM_Posts table in the data store.
Public classPMInbox
This is the PM Center for a specific user. It shows as a thread view of conversations.
Public classPMInfo
Represents a single row of data for the Forum_PMPosts table.
Public classPMThread
This is a single private message thread. It looks like a forum post screen by design. It was designed to show an entire thread as a single conversation and allow the user to reply like posts view.
Public classPMThreadController
Ties the corresponding info object to the data layer.
Public classPMThreadInfo
A single instance of the Private Message Thread Info object.
Public classPollController
Communicates with the Forum_Polls_Polls table in the data store.
Public classPollInfo
All properties associated with the Forum_Polls_Polls table in the data store.
Public classPostController
Communicates with the Forum_Posts table in the data store. Note that some items in the data store also interact with the Forum_Threads table as well.
Public classPostDelete
All post deletes are done from this page.
Public classPostEdit
This is where all posts are added and/or edited from. It also fires off email notification and factors in moderation.
Public classPostInfo
Creates an instance of the post info object
Public classPostModerate
This is the moderation queue page for a specific Forum.
Public classPostReport
Post abuse reporting is done from this screen.
Public classPosts
Renders the Posts view UI.
Public classPostSearchInfo
Public classRss
Used for all Forum RSS Feeds.
Public classRssDocument
Used to create RSS Feeds for forums.
Public classSearchController
This class connects the search custom business object to the data layer.
Public classSearchInfo
Search Info is a 'hybrid' type class used to create a custom business object that represents merged results of a search from posts/threads tables.
Public classSearchPage
Gathers search criteria from the end user then uses this to navigate to the search results page.
Public classSearchTerms
A Helper class used to build the post/thread search self contained within the module. This is also the basis for "My Posts".
Public classSettings
This is the General Settings area from Forum Administration. Set basic configuration items for this forum module. (mod settings)
Public classSqlDataProvider
The Microsoft SQL specific provider to allow Forum module to communicate with a data store.
Public classStartEmailQueuedTasks
This is the Email Queue Task handler. It is designed to allow email notifications to be sent using a background thread and to not worry about the ASP.NET default limitation of 25 threads since only one will be spawned to handle this. This is all methods necessary to use the core Scheduler for tasks.
Public classStatsRanks
The control which allows forum administrators to configure the module settings which control forum ratings, rankings, and statistics and how they behave in this module.
Public classTemplateAdmin
Basically a page with links to other pages using FURLs.
Public classThreadController
The ThreadController class includes the option interfaces such as ISearchable, IUpgradeable in addition to the standard Get, GetAll, Update, Delete items to hook into the DAL
Public classThreadInfo
A cached instance of a thread info object.
Public classThreadMove
Allows a moderator/admin to move a thread to a new forum.
Public classThreadRateInfo
All properties associated with the Forum_ThreadRating table in the data store.
Public classThreads
This renders the threads view (second view in hierarchy of forum)
Public classThreadSearch
This renders the search results view (similar to thread view - only reachable from modules search, user profile, or my settings)
Public classThreadSearchInfo
Public classThreadSplit
Allows a moderator/admin to move a thread to a new forum.
Public classTrackingController
This is what gets/sets the forum/thread notification options for subscriptions.
Public classTrackingInfo
Tracking info object.
Public classUpgradeLogic
We use IUpgradeable to cleanup files from older installations and to add database entries which require ModuleDefinitionID (such as lists, module permissions).
Public classUpgradeLogic..::ForumModeratorInfo
Upgrade logic specific to ForumModerators.
Public classUpgradeLogic..::ForumPermInfo
Upgrade Logic specific to Forum Permissions.
Public classUserAnswerController
Communicates with the Forum_Polls_UserAnswers table in the data store.
Public classUserAnswerInfo
All properties associated with the Forum_Polls_UserAnswers table in the data store.
Public classUserForumsController
Communicates with the Forum_UserForums table in the data store.
Public classUserForumsInfo
Represents single row of data for a userid/forumid read combination.
Public classUserManage
Allows forum administrators to manage all forum users. This lists all portal users to allow administrator to manage those users whom have not yet visited the module as well.
Public classUserSettings
This is the users "My Settings" page and also the page used for administrators of the module to change forum user settings. This is the forum users profile.
Public classUserThreadsController
Hanldes the Thread read status for a single user instance.
Public classUserThreadsInfo
Creates a custom business object that represents one row of data from the Forum_UserThreads table.
Public classUtils
Various utility methods used throughout the forum module. This includes links.
Public classWordFilterController
Communicates with the Forum_WordFilter table in the data store.

Structures

  StructureDescription
Public structureRssDocument..::RssChannel
RssChannel represents a ForumID.
Public structureRssDocument..::RssItem
RssItem represents a PostID.
Public structureSearchTerms..::SearchTerm
SearchTerms represent logic used to build the comparative parts of an SQL query.

Interfaces

  InterfaceDescription
Public interfaceIEmailQueueable
Interface used for consumption of modules wishing to schedule emails sends.

Enumerations

  EnumerationDescription
Public enumerationAvatarControlType
The various avatar types are handled differently so we need this variable to determine how the control behaves.
Public enumerationCompareOperator
The compare operator is used for building dynamic SQL for search
Public enumerationEmailQueueTaskInfo..::EnumEmailQueueTaskPriority
This determines the priority of the sending queue items. Logic is used in the sproc to retrieve what task to queue and send next based on the combination of priority here and the date created along w/ scheduled start date.
Public enumerationForumBehavior
Determines how a forum will behave in terms of viewing and post restrictions. Also includes if a forum is moderated or unmoderated.
Public enumerationForumContentTypeID
ForumContentType is used for determining which type of keywords should be retrieved from the database. These are used for showing what options are available to be rendered during parsing.
Public enumerationForumDisplayName
The options available for how the user's name is displayed throughout the module.
Public enumerationForumEmailType
These are the various email template types available for parsing (if active) used in notification emails.
Public enumerationForumScope
ForumScope is used for controlling which class to instantiate in the Forum_Container.ascx dispatch page.
Public enumerationForumTemplateTypes
These are the various template types used in this module. This is only partially implemented/active.
Public enumerationForumTreeview..::eImageType
The image type to use to represent the various levels in the treeview.
Public enumerationForumType
Options for how a forum behaves. Notifications forums are forced subscriptions. Link forums are just links, no actual forum inside.
Public enumerationModerateAction
Determines the type of action the moderator is performing.
Public enumerationPMAction
Similar to PostAction, except specific to Private Messages
Public enumerationPostAction
The PostAction determines how a post is initially loaded in post edit and what other items to display in that screen. It also determines which sproc is called when submitting.
Public enumerationPosterRank
The different levels of user post rankings, this is determined on a per portal basis by post count and settings (if enabled)
Public enumerationShowPosterLocation
Options available for displaying poster's location in each post.
Public enumerationThreadStatus
The different levels of forum thread status available to end users (if settings is enabled)
Public enumerationUtils..::ForumPage
This enum represents the available forum control views. All Container named ones load in the Forum_Container.ascx dynamically