Sitefinity CMS
Contents
Important Interfaces of Forums Modules Send comments on this topic.
See Also
Developing with Sitefinity > Modules > Modules API > Forums > Important Interfaces of Forums Modules

Glossary Item Box

The Forums module creates and works with two kinds of data:

  • Forum
  • Post
  • Categories

Forum represents a forum, and Post represents a single post in the forum. The Forum object implements the IForum interface, and the Post object implements the IPost interface. Since you will be working with the objects of IForum and IPost types, first take a look at a description of the interfaces and their members.

 

When working with the administrative part of Sitefinity, a forum consists of threads, while a thread consists of posts. However, the module is not implemented using this structure. A thread is actually the first post in a forum, and any answer to it is considered as its child thread. This means that any consequent answer will belong to a given parent, and the first post is actually the root post (parent). Because of this there is no Thread object and no IThread interface - only IForum and IPost.

 

Categories are like folders - a single forum could belong to only one category. Categories for Forums differ from the categories used in other modules.

 

IForum Members

Member name  Member type  Comments
ID  Guid  Unique identifier (Primary key) of the forum.
Name string  Name/Title of the forum.
Description string  Description of the forum.
DateCreated DateTime Date and time the forum is created.
DenyAnonymous bool If true, this boolean value indicates that non-authenticated users are not allowed to post in the forum.
ModeratePosts bool If true, this boolean value indicates that each new post should be approved before publishing it.
Category ICategory The category to which the forum belongs.
Status ForumStatus

Status of the forum. ForumStatus is an enumeration which consists of the following possibilities:

  • Visible
  • Hidden 
  • Locked
Posts IList A list of all posts that belong to threads of this forum.

 

IPost Members

Member name  Member type  Comments
ID  Guid  Unique identifier (Primary key) of the post.
Title  string  Title of the post.
Content string  Content of the post.
DateCreated DateTime Date and time the post is created.
AuthorIP string  The IP of the author of the post.
Parent IPost

The parent post to which this post is targeted (replies).
ForumID IForum ID of the forum this post belongs to.
Thread IPost The root thread containing this post.
Owner string The user who has created this post.
Status PostStatus

Status of the post. PostStatus is an enumeration which consists of the following possibilities, depending on whether the post is a thread or a post:

  • ThreadVisible
  • ThreadHidden
  • ThreadLocked
  • PostVisible
  • PostHidden

 

ICategory Members

Member name  Member type  Comments
ID  Guid  Unique identifier (Primary key) of the category.
Name string  Name of the category.
Description string  Description of the category.
Forums IList A list of all forums (IForum items) that belong to this category.
 

 

See Also