MessageBoardManager

The MessageBoardManager class manages items that are posted on a message board.

Namespace

Ektron.Cms.Framework.Community.MessageBoardManager

Methods

IsUserMessageBoardAdmin(Int64,MessageBoardObjectType,Int64). Checks whether a user is a MessageBoard admin.

Add. Adds a message board post.

Add

Add(Ektron.Cms.MessageBoardData)

Adds a message board post with details from the supplied MessageBoardData object.

Authenticated users

CMS Administrators

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

* Object Type
* Object Value
Message Text

Parameters

messageBoardData. Message board post data to add.

Returns

Returns the custom MessageBoardData object added.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageBoardObjectTypeLabel" AssociatedControlID="uxMessageBoardObjectType" CssClass="span-4 last" runat="server" Text="* Object Type:" />
        <asp:DropDownList ID="uxMessageBoardObjectType" runat="server">
            <asp:ListItem>Community Group</asp:ListItem>
            <asp:ListItem>User</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-4 last" runat="server" Text="* ObjectValue:" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageTextLabel" AssociatedControlID="uxMessageText" CssClass="span-4 last" runat="server" Text="* Message Text:" />
        <asp:TextBox TextMode="MultiLine" Rows="3"  ID="uxMessageText" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            MessageBoardManager messageBoardManager = new MessageBoardManager();
            
            CommunityGroupManager communityGroupManager = new CommunityGroupManager();
            CommunityGroupData communityGroupData = (uxMessageBoardObjectType.SelectedItem.Text == "Community Group" ? communityGroupManager.GetItem(Convert.ToInt64(uxObjectValue.Text)) : null);

            if (communityGroupData != null || uxMessageBoardObjectType.SelectedItem.Text != "Community Group")
            {
                MessageBoardData messageBoardData = new MessageBoardData()
                {
                    ObjectType = (uxMessageBoardObjectType.SelectedItem.Text == "Community Group" ? Ektron.Cms.Common.EkEnumeration.MessageBoardObjectType.CommunityGroup : Ektron.Cms.Common.EkEnumeration.MessageBoardObjectType.User),
                    ObjectId = long.Parse(uxObjectValue.Text),
                    MessageText = uxMessageText.Text,
                    UserId = messageBoardManager.RequestInformation.UserId
                };

                messageBoardManager.Add(messageBoardData);
                MessageUtilities.UpdateMessage(uxMessage, "Message Board message added with Id " + messageBoardData.Id, Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Community Group Object Value is invalid.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Approve (post). Approves a message board post.

Approve (post)

Approve(System.Int64)

Approves a message board post.

Authenticated users

CMS Administrators
Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

* ID

Parameters

id. ID of the message board post.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageBoardIdLabel" AssociatedControlID="uxMessageBoardId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxMessageBoardId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Approve"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long messageBoardId = long.Parse(uxMessageBoardId.Text);

            MessageBoardManager messageBoardManager = new MessageBoardManager();
            messageBoardManager.Approve(messageBoardId);

            MessageUtilities.UpdateMessage(uxMessage, "Message board message approved.", Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Approve (list). Approves a list of messages to the message board.

Approve (list)

Approve(System.Collections.Generic.List)

Approves a list of messages to the message board.

Authenticated users

CMS Administrators
Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

* IDs (comma separated)

Parameters

ids. The list of the IDs.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageBoardIdLabel" AssociatedControlID="uxMessageBoardId" CssClass="span-4 last" runat="server" Text="* Ids (Comma Seperated) :" />
        <ektronUI:TextField ID="uxMessageBoardId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Approve"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            List<long> listMessageBoardIds = new List<long>();
            string messageBoardIds = uxMessageBoardId.Text;
            string[] strMessageBoardIds = messageBoardIds.Split(new char[] { ',' });

            foreach (string str in strMessageBoardIds)
            {
                listMessageBoardIds.Add(Convert.ToInt64(str));
            }

            MessageBoardManager messageBoardManager = new MessageBoardManager();
            messageBoardManager.Approve(listMessageBoardIds);

            MessageUtilities.UpdateMessage(uxMessage, "Message Boards with Ids " + messageBoardIds + " approved.", Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Delete (post). Deletes a message board post.

Delete (post)

Delete(System.Int64)

Deletes a message board post from the CMS.

Authenticated users

CMS Administrators

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

* ID

Parameters

id. ID of the message board post to delete.

Remarks

Validate the item using GetItem() before deleting.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageBoardIdLabel" AssociatedControlID="uxMessageBoardId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxMessageBoardId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix" style="color: red;">
                    <ektronUI:Label ID="uxStatus" Visible="false" CssClass="span-9 last" runat="server"
                        Text="Status:" />
                </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Delete"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            long messageBoardId = long.Parse(uxMessageBoardId.Text);

            MessageBoardManager messageBoardManager = new MessageBoardManager();
            MessageBoardData messageBoardData = messageBoardManager.GetItem(messageBoardId);

            if (messageBoardData != null && messageBoardData.Id > 0)
            {
                messageBoardManager.Delete(messageBoardId);
                MessageUtilities.UpdateMessage(uxMessage,  "Message Board with Object Id " + messageBoardId + " deleted.", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter valid messageBoardId.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Delete (list). Deletes a list of message board posts.

Delete (list)

Delete(System.Collections.Generic.List)

Deletes a list of message board posts.

Authenticated users

CMS Administrators

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

* Object ID
* Object Type

Parameters

ids. A comma-separated list of the IDs.

Remarks

Validate the item using GetItem() before deleting.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageBoardIdLabel" AssociatedControlID="uxMessageBoardId" CssClass="span-6 last" runat="server" Text="* ids (Comma Seperated):" />
        <ektronUI:TextField ID="uxMessageBoardId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Delete"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-6" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            List<long> listMessageBoardIds = new List<long>();
            string messageBoardIds = uxMessageBoardId.Text;
            string[] strMessageBoardIds = messageBoardIds.Split(new char[] { ',' });
        
            foreach (string str in strMessageBoardIds)
            {
                listMessageBoardIds.Add(Convert.ToInt64(str));
            }
           
            MessageBoardManager messageBoardManager = new MessageBoardManager();
            messageBoardManager.Delete(listMessageBoardIds);

            MessageUtilities.UpdateMessage(uxMessage, "Message Boards with Ids " + messageBoardIds + "  deleted.", Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Delete (object). Deletes all message board posts of a specified object.

Delete (object)

Delete(System.Int64,Ektron.Cms.Common.EkEnumeration.MessageBoardObjectType)

Deletes all message board posts of a specified object.

Authenticated users

CMS Administrators

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

* Object ID
* Object Type

Parameters

objectId. ID of the object for which to delete posts. The type of object identified by the ID is defined by the MessageBoardObjectType parameter.
objectType. The type of the object for which to delete posts.

Remarks

Validate the item using GetItem() before deleting.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageBoardIdLabel" AssociatedControlID="uxMessageBoardId" CssClass="span-3 last" runat="server" Text="* Object Id:" />
        <ektronUI:TextField ID="uxMessageBoardId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
            <ektronUI:Label ID="uxMessageBoardObjectTypeLabel" AssociatedControlID="uxMessageBoardObjectType" CssClass="span-3 last" runat="server" Text="* Object Type:" />
            <asp:DropDownList ID="uxMessageBoardObjectType" runat="server">
                <asp:ListItem>Community Group</asp:ListItem>
                <asp:ListItem>User</asp:ListItem>
            </asp:DropDownList>
        </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Delete"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Common;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            long objectId = long.Parse(uxMessageBoardId.Text);
            EkEnumeration.MessageBoardObjectType ObjectType = (uxMessageBoardObjectType.SelectedItem.Text == "Community Group" ? EkEnumeration.MessageBoardObjectType.CommunityGroup : EkEnumeration.MessageBoardObjectType.User);

            MessageBoardManager messageBoardManager = new MessageBoardManager();
            messageBoardManager.Delete(objectId, ObjectType);

            MessageUtilities.UpdateMessage(uxMessage, "Message Board with Object Id " + objectId + " and Object Type " + ObjectType.ToString() + "  deleted.", Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetItem. Retrieves the properties of a specific MessageBoardData object.

GetItem

GetItem(System.Int64)

Retrieves the properties of a specific MessageBoardData object.

Authenticated users

CMS Administrators

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

* ID

Parameters

id. ID of the message board to get.

Returns

Message board details in a MessageBoardData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageBoardIdLabel" AssociatedControlID="uxMessageBoardId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxMessageBoardId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Item"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxObjectId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxObjectType" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxMessageText" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxUserName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxIsModerated" runat="server"></asp:Literal>
    </li>
</ol>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long messageBoardId = long.Parse(uxMessageBoardId.Text);

            MessageBoardManager messageBoardManager = new MessageBoardManager();
            MessageBoardData messageBoardData = messageBoardManager.GetItem(messageBoardId);

            if (messageBoardData != null && messageBoardData.Id > 0)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for message board with ID " + messageBoardId + " are below", Message.DisplayModes.Success);
                uxObjectId.Text = "Object Id : " + messageBoardData.ObjectId;
                uxObjectType.Text = "Object Type : " + messageBoardData.ObjectType.ToString();
                uxMessageText.Text = "Message Text : " + messageBoardData.MessageText;
                uxUserName.Text = "User Name : " + messageBoardData.UserName;
                uxIsModerated.Text = "Is Moderated :" + messageBoardData.IsModerated;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage,  "Message board does not exists. ", Message.DisplayModes.Error);
            }

            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetList. Retrieves lists of objects.

GetList

GetList(MessageBoardCriteria)

Retrieves lists of objects through the GetList(MessageBoardCriteria) method.

Authenticated users

CMS Administrators

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

Community Group Property
* Object Value

Parameters

criteria. Used to specify, or filter, the message board to return.

Returns

A list of message boards.

Criteria use

The DataProperty enum works with its criteria class and defines the properties that the Manager class uses to filter and order. Specify zero (0) or more criteria to retrieve the objects you want. The criteria object also lets you set the number of items to return, define paging data, and modify sorting.

Criteria objects

Condition. The Logical operator to apply to the filters. The default value is "AND". The criteria condition controls the operator for the default filter group and the AND-ing\Or-ing the filter groups together.
```
public Ektron.Cms.Common.LogicalOperation Condition { set; get; }
```
FilterGroups. Gets a list of filter groups. Filter groups can be created to do filter grouping (that is, parentheses in the where clause). The groups use the criteria's condition like other filters, but can use their own condition internally.
```
public 
  System.Collections.Generic.List<CriteriaFilterGroup<ActivityCommentProperty>> 
  FilterGroups { get; }
```
Filters. Lists of filters defined in this criteria object. To add new Filters, you can add them here or use the AddFilter method (recommended).
```
public 
  System.Collections.Generic.List<CriteriaFilter<ActivityCommentProperty>> 
  Filters { get; }
```

GroupByField. The group by field to apply to the results.

public 
  Ektron.Cms.Activity.ActivityCommentProperty 
  GroupByField { set; get; }

OrderByDirection. Sets the order direction (ascending or descending).

public EkEnumeration.OrderByDirection 
  OrderByDirection { set; get; }

OrderByField . Set the property used to order the results.

public Ektron.Cms.Activity.ActivityCommentProperty 
  OrderByField { set; get; }

PagingInfo. By default, page size is 50 for improved performance. Example paging Info:

PagingInfo pageinfo = new PagingInfo();
pageinfo.CurrentPage=1;
pageinfo.RecordsPerPage = 100;
criteria.PagingInfo = pageinfo;

Constructor(property, orderbyDirection)

Sorts the results by a property in ascending or descending order.

AddFilter(property, operator, value)

Filters the results based on the conditions defined in this method.

criteria.AddFilter(Property.ObjectType, 
  CriteriaFilterOperator.EqualTo, Objectvalue);

LogicalOperation Condition

Filters the array of items based on the logical condition set in the AddFilter properties.

criteria.AddFilter(Property.ObjectType, 
  CriteriaFilterOperator.EqualTo,Objectvalue);

List<CriteriaFilterGroup> FilterGroups

Binds data to a listview or gridview.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageBoardPropertyLabel" AssociatedControlID="uxMessageBoardProperty" CssClass="span-6 last" runat="server" Text="CommunityGroupProperty:" />
        <asp:DropDownList ID="uxMessageBoardProperty" runat="server">
            <asp:ListItem>Object Id</asp:ListItem>
            <asp:ListItem>Object Type (0,1,2,3)</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-6 last" runat="server" Text="* ObjectValue:" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get List"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-6" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
 
<asp:ListView ID="uxMessageBoardListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Object Id
                    </th>
                    <th>
                        Object Type
                    </th>
                    <th>
                        Is Moderated
                    </th>
                    <th>
                        Message Text
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
                <td class="devsite-method">
                <%# Eval("ObjectId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ObjectType")%>
            </td>
            <td class="devsite-method">
                <%# Eval("IsModerated")%>
            </td>
            <td class="devsite-method">
                <%# Eval("MessageText")%>
            </td>
        </tr>
    </ItemTemplate>
</asp:ListView>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Common;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            object Objectvalue;

            Ektron.Cms.Community.MessageBoardCriteria criteria = new Ektron.Cms.Community.MessageBoardCriteria();
            if (uxMessageBoardProperty.SelectedItem.Text == "Object Id")
            {
                Objectvalue = Convert.ToInt64(uxObjectValue.Text);
                criteria.AddFilter(MessageboardProperty.ObjectId, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(MessageboardProperty.ObjectType, CriteriaFilterOperator.EqualTo, Objectvalue);
            }

            MessageBoardManager messageBoardManager = new MessageBoardManager();
            List<MessageBoardData> messageBoardDataList = messageBoardManager.GetList(criteria);

            uxMessageBoardListView.Visible = true;
            uxMessageBoardListView.DataSource = messageBoardDataList;
            uxMessageBoardListView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetReplyList. Retrieves a list of replies for a specified message.

GetReplyList

GetReplyList(System.Int64)

Retrieves a list of replies for a specified message.

Authenticated users

CMS Administrators
Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

* ID

Parameters

id. ID of the message.

Returns

A list of message boards.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageBoardIdLabel" AssociatedControlID="uxMessageBoardId" CssClass="span-6 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxMessageBoardId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Replies"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-6" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
 
<asp:ListView ID="uxMessageBoardListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Object Id
                    </th>
                    <th>
                        Object Type
                    </th>
                    <th>
                        Message Text
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
                <td class="devsite-method">
                <%# Eval("ObjectId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ObjectType")%>
            </td>
            <td class="devsite-method">
                <%# Eval("MessageText")%>
            </td>
        </tr>
    </ItemTemplate>
</asp:ListView>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long messageBoardId = long.Parse(uxMessageBoardId.Text);

            MessageBoardManager messageBoardManager = new MessageBoardManager();
            List<MessageBoardData> messageBoardData = messageBoardManager.GetReplyList(messageBoardId);

            uxMessageBoardListView.Visible = true;
            uxMessageBoardListView.DataSource = messageBoardData;
            uxMessageBoardListView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetUnapprovedList. Retrieves a list of unapproved messages from the message board for a specified message.

GetUnapprovedList

GetUnapprovedList(MessageBoardObjectType,Int64,Paginginfo)

Retrieves a list of unapproved messages from the message board for a specified message.

Authenticated users

CMS Administrators
Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

* Object Type
* Object ID
* Records per page

Parameters

ObjectType. The type of the object.
ObjectID. The ID of the object.
RecordsPerPage. The number of records per page.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageBoardPropertyLabel" AssociatedControlID="uxObjectType" CssClass="span-4 last" runat="server" Text="* Object Type:" />
        <asp:DropDownList ID="uxObjectType" runat="server">
            <asp:ListItem>Content</asp:ListItem>
            <asp:ListItem>User</asp:ListItem>
            <asp:ListItem>CommunityGroup</asp:ListItem>
            <asp:ListItem>Messageboard Reply</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxUserIdLabel" AssociatedControlID="uxObjectId" CssClass="span-4 last" runat="server" Text="* Object Id:" />
        <ektronUI:TextField ID="uxObjectId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxRecordsPPLabel1" AssociatedControlID="uxRecordsPP" CssClass="span-4 last" runat="server" Text="* Records per Page:" />
        <ektronUI:TextField ID="uxRecordsPP" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="100" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get List"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
            
<asp:ListView ID="uxMessageBoardListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Object Id
                    </th>
                    <th>
                        Object Type
                    </th>
                    <th>
                        Is Moderated
                    </th>
                    <th>
                        Message Text
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
                <td class="devsite-method">
                <%# Eval("ObjectId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ObjectType")%>
            </td>
            <td class="devsite-method">
                <%# Eval("IsModerated")%>
            </td>
            <td class="devsite-method">
                <%# Eval("MessageText")%>
            </td>
        </tr>
    </ItemTemplate>
</asp:ListView>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long objectId = long.Parse(uxObjectId.Text);
            EkEnumeration.MessageBoardObjectType objectType = (EkEnumeration.MessageBoardObjectType)uxObjectType.SelectedIndex;

            PagingInfo pagingInfo = new PagingInfo();
            pagingInfo.RecordsPerPage = int.Parse(uxRecordsPP.Text);

            MessageBoardManager messageBoardManager = new MessageBoardManager();
            List<MessageBoardData> messageBoardDataList = messageBoardManager.GetUnapprovedList(objectType, objectId, pagingInfo);

            uxMessageBoardListView.Visible = true;
            uxMessageBoardListView.DataSource = messageBoardDataList;
            uxMessageBoardListView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Update. Updates an existing message board item.

Update

Update(Ektron.Cms.FriendTaxonomyData)

Updates an existing message board item in the CMS.

Authenticated users

CMS Administrators

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

* Message ID
* Message Text

Parameters

messageBoardData. Message board post data to update.

Returns

Returns the custom MessageBoardData object updated.

Remarks

Validate the message board item with GetItem() before you update the properties. Then, call Update with your modified MessageBoardData object.

NOTE: You cannot change all properties after the initial Add event, such as the MessageBoardData.Type.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-4 last" runat="server" Text="* Message Id:" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageTextLabel" AssociatedControlID="uxMessageText" CssClass="span-4 last" runat="server" Text="* Message Text:" />
        <asp:TextBox TextMode="MultiLine" Rows="3"  ID="uxMessageText" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Update"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li> 
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {

        try
        {
            MessageBoardManager messageBoardManager = new MessageBoardManager();

            long objectId = long.Parse(uxObjectValue.Text);

            MessageBoardData messageBoardData = messageBoardManager.GetItem(objectId);
            if (messageBoardData != null)
            {
                messageBoardData.MessageText = uxMessageText.Text != string.Empty ? uxMessageText.Text : messageBoardData.MessageText;
                messageBoardManager.Update(messageBoardData);

                MessageUtilities.UpdateMessage(uxMessage,  "Message Board message updated. ", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage,  "Message Board does not exists.  ", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);

        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Data classes

Data Classes

MessageBoardData

Namespace

Ektron.Cms

Properties

AllowApproval
```
public bool AllowApproval { set; get; }
```
AllowDelete
```
public bool AllowDelete { set; get; }
```

AllowModeration

public bool AllowModeration { set; get; }

DateCreated

public System.DateTime DateCreated { set; get; }

DateModified

public System.DateTime DateModified { set; get; }

DisplayName
```
public string DisplayName { set; get; }
```

DisplayUserName

public string DisplayUserName { set; get; }

HasPendingReplies
```
public bool HasPendingReplies { get; }
```
HasReplies
```
public bool HasReplies { get; }
```
Id
```
public override long Id { set; get; }
```
IsModerated. Gets or sets the IsModerated flag. This flag is used on ADD to determine if the message board post should follow moderation. On retrieval, it will not be set because the message board post itself has no concept of moderation.
```
public bool IsModerated { set; get; }
```
LanguageId
```
public int LanguageId { set; get; }
```
MessageId
```
public long MessageId { set; get; }
```
MessageText
```
public string MessageText { set; get; }
```
ObjectId
```
public long ObjectId { set; get; }
```

ObjectType

public EkEnumeration.MessageBoardObjectType ObjectType { set; get; }

PendingReplies
```
public int PendingReplies { set; get; }
```
ReplyCount
```
public int ReplyCount { set; get; }
```
SiteId
```
public long SiteId { set; get; }
```
Status
```
public string Status { set; get; }
```
UserAvatar
```
public string UserAvatar { set; get; }
```

UserEmailAddress

public string UserEmailAddress { set; get; }

UserFirstname

public string UserFirstName { set; get; }

UserId
```
public long UserId { set; get; }
```

UserLastName

public string UserLastname { set; get; }

UserName
```
public string UserName { set; get; }
```
UserRole
```
public string UserRole { set; get; }
```

MessageBoardManager

Namespace

Constructors

Properties

Methods

Add

Authenticated users

Fields

Parameters

Returns

.aspx code snippet

.aspx.cs code-behind namespace

.aspx.cs code-behind method

Approve (post)

Authenticated users

Fields

Parameters

.aspx code snippet

.aspx.cs code-behind namespace

.aspx.cs code-behind method

Approve (list)

Authenticated users

Fields

Parameters

.aspx code snippet

.aspx.cs code-behind namespace

.aspx.cs code-behind method

Delete (post)

Authenticated users

Fields

Parameters

Remarks

.aspx code snippet

.aspx.cs code-behind namespace

.aspx.cs code-behind method

Delete (list)

Authenticated users

Fields

Parameters

Remarks

.aspx code snippet

.aspx.cs code-behind namespace

.aspx.cs code-behind method

Delete (object)

Authenticated users

Fields

Parameters

Remarks

.aspx code snippet

.aspx.cs code-behind namespace

.aspx.cs code-behind method

GetItem

Authenticated users

Fields

Parameters

Returns

.aspx code snippet

.aspx.cs code-behind namespace

.aspx.cs code-behind method

GetList

Authenticated users

Fields

Parameters

Returns

Criteria use

Criteria objects

Constructor(property, orderbyDirection)

AddFilter(property, operator, value)

LogicalOperation Condition

List<CriteriaFilterGroup> FilterGroups

.aspx code snippet

.aspx.cs code-behind namespace

.aspx.cs code-behind method

GetReplyList

Authenticated users

Fields

Parameters

Returns

.aspx code snippet

.aspx.cs code-behind namespace