MicromessageManager

The MicromessageManager class manages user status messages that are posted to an activity stream.

Namespace

Ektron.Cms.Framework.Community.MicromessageManager

Constructors

  • MicromessageManager()
  • MicromessageManager(ApiAccessMode)

Properties

  • ApiMode. Gets or sets the current API access mode. If set to Admin, the API runs with the permissions of an administrator.
  • ApplicationPath. Gets the application path to the Workarea.
  • ContentLanguage. Gets or sets the current content language.
  • InPreviewMode. Gets or sets the preview mode and returns true if the site is in preview mode.
  • IsCommerceEnabled. Checks for a commerce license.
  • MicromessageManagerService. Returns an instance of the business objects micromessage manager service.
  • RequestInformation. Gets information about the current request.
  • SitePath. Gets the site path.
  • UserId. Gets or sets the ID of the currently logged-in user.

Methods

Add

Add(Ektron.Cms.MicroMessageData)

Adds a micro-message with details from the supplied MicroMessageData 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

  • * Message Text

Parameters

  • data. The micro-message data.

Returns

Returns the custom MicroMessageData object added.

.aspx code snippet

<ol class="formFields">
    <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
        {
            MicromessageManager microMessageManager = new MicromessageManager();
            MicroMessageData microMessageData = new MicroMessageData()
            {
                MessageText = uxMessageText.Text ,
                SiteId = 0,
                UserId = microMessageManager.RequestInformation.UserId 
            };

            microMessageManager.Add(microMessageData);

            MessageUtilities.UpdateMessage(uxMessage, "Micro message added with Id " + microMessageData.Id, Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);

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

AddReply

AddReply(System.Int64,System.String)

Adds a new reply.

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
  • * Reply Text

Parameters

  • parentMessageId. ID of the micro-message to which to add a reply.
  • messageText. The text of the reply.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageIdLabel" AssociatedControlID="uxMessageId" CssClass="span-4 last" runat="server" Text="* Message Id:" />
        <ektronUI:TextField ID="uxMessageId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageTextLabel" AssociatedControlID="uxMessageText" CssClass="span-4 last" runat="server" Text="* Reply 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 Reply"></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
        {
            long messageId = long.Parse(uxMessageId.Text);

            MicromessageManager micromessageManager = new MicromessageManager();
            micromessageManager.AddReply(messageId, uxMessageText.Text);

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

Delete

Delete(System.Int64)

Deletes a micro-message 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 micro-message to be deleted.

Remarks

Validate the item using GetItem() before deleting.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageIdLabel" AssociatedControlID="uxMessageId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxMessageId" 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-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;
using Ektron.Cms;

.aspx.cs code-behind method

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

            MicromessageManager microMessageManager = new MicromessageManager();
            MicroMessageData microMessageData = microMessageManager.GetItem(messageBoardId);
            if (microMessageData != null)
            {
                microMessageManager.Delete(messageBoardId);
                MessageUtilities.UpdateMessage(uxMessage, "Micro Message deleted.", Message.DisplayModes.Success);
            }
            else 
            {
                MessageUtilities.UpdateMessage(uxMessage, "Micro Message doesn't exists.", Message.DisplayModes.Error);
            }
            
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetColleagueMessageList

GetColleagueMessageList(Ektron.Cms.PagingInfo)

Retrieves a list of colleague messages.

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

  • * Records per page

Parameters

  • paging. The paging object. Setting RecordsPerPage = 0 retrieves all rows.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxRecordsLabel" AssociatedControlID="uxRecords" CssClass="span-4 last" runat="server" Text="* Records per page:" />
        <ektronUI:TextField ID="uxRecords" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="10" />
    </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="uxMicroMessageDataListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Id
                    </th>
                    <th>
                        User Id
                    </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("Id")%>
            </td>
            <td class="devsite-method">
                <%# Eval("UserId")%>
            </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
        {
            PagingInfo pagingInfo = new PagingInfo();
            pagingInfo.RecordsPerPage = int.Parse(uxRecords.Text);

            MicromessageManager micromessageManager = new MicromessageManager();
            List<MicroMessageData> microMessageDataList = micromessageManager.GetColleagueMessageList(pagingInfo);

            uxMicroMessageDataListView.Visible = true;
            uxMicroMessageDataListView.DataSource = microMessageDataList;
            uxMicroMessageDataListView.DataBind();

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

GetItem

GetItem(System.Int64)

Retrieves the properties of a specific MicroMessageData 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 micro-message.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageIdLabel" AssociatedControlID="uxMessageId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxMessageId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </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="uxUserId" 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="uxReplyCount" 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 messageId = long.Parse(uxMessageId.Text);

            MicromessageManager micromessageManager = new MicromessageManager();
            MicroMessageData microMessageData = micromessageManager.GetItem(messageId);

            if (microMessageData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for message with ID " + messageId + " are below", Message.DisplayModes.Success);
                uxUserId.Text = "User Id : " + microMessageData.UserId;
                uxMessageText.Text = "Message Text : " + microMessageData.MessageText;
                uxUserName.Text = "User Name : " + microMessageData.UserName;
                uxReplyCount.Text = "Reply Count :" + microMessageData.ReplyCount;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Message does not exists. ", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetList

GetList(MicromessageCriteria)

Retrieves lists of objects.

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

  • * Micro-message Property
  • * Object Value

Parameters

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.

Remarks

Use ListView because it has a paging option and data grouping.

Use the default page size = 50.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxMicroMessagePropertyLabel" AssociatedControlID="uxMicroMessageProperty" CssClass="span-6 last" runat="server" Text="* MicroMessageProperty:" />
        <asp:DropDownList ID="uxMicroMessageProperty" runat="server">
            <asp:ListItem>UserId</asp:ListItem>
            <asp:ListItem>MessageText</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="uxMicroMessageDataListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Id
                    </th>
                    <th>
                        User Id
                    </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("Id")%>
            </td>
            <td class="devsite-method">
                <%# Eval("UserId")%>
            </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;

            MicroMessageCriteria criteria = new MicroMessageCriteria(MicroMessageProperty.MessageId, EkEnumeration.OrderByDirection.Ascending);
            if (uxMicroMessageProperty.SelectedItem.Text == "UserId")
            {
                Objectvalue = Convert.ToInt64(uxObjectValue.Text);
                criteria.AddFilter(MicroMessageProperty.UserId, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(MicroMessageProperty.MessageText, CriteriaFilterOperator.Contains, Objectvalue);
            }

            MicromessageManager micromessageManager = new MicromessageManager();
            List<MicroMessageData> microMessageDataList = micromessageManager.GetList(criteria);

            uxMicroMessageDataListView.Visible = true;
            uxMicroMessageDataListView.DataSource = microMessageDataList;
            uxMicroMessageDataListView.DataBind();

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

GetPublicMessageList

GetPublicMessageList(Ektron.Cms.PagingInfo)

Retrieves a list of public and colleague messages that the requesting user has permission to see.

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

  • * Records per page

Parameters

  • paging. The paging object. Setting RecordsPerPage = 0 retrieves all rows.

Returns

Returns a list of for the user messages.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxRecordsLabel" AssociatedControlID="uxRecords" CssClass="span-6 last" runat="server" Text="* Records per page:" />
        <ektronUI:TextField ID="uxRecords" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="10" />
    </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="uxMicroMessageDataListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Id
                    </th>
                    <th>
                        User Id
                    </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("Id")%>
            </td>
            <td class="devsite-method">
                <%# Eval("UserId")%>
            </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
        {
            PagingInfo pagingInfo = new PagingInfo();
            pagingInfo.RecordsPerPage = int.Parse(uxRecords.Text);

            MicromessageManager micromessageManager = new MicromessageManager();
            List<MicroMessageData> microMessageDataList = micromessageManager.GetPublicMessageList(pagingInfo);

            uxMicroMessageDataListView.Visible = true;
            uxMicroMessageDataListView.DataSource = microMessageDataList;
            uxMicroMessageDataListView.DataBind();

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

GetReplyList

GetReplyList(System.Int64)

Retrieves a list of replies for a specified micro-message.

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

Parameters

  • parentMessageId. ID of the micro-message that has replies.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageIdLabel" AssociatedControlID="uxMessageId" CssClass="span-4 last" runat="server" Text="* Message Id:" />
        <ektronUI:TextField ID="uxMessageId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Reply 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="uxMicroMessageDataListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Id
                    </th>
                    <th>
                        User Id
                    </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("Id")%>
            </td>
            <td class="devsite-method">
                <%# Eval("UserId")%>
            </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 messageId = long.Parse(uxMessageId.Text);

            MicromessageManager micromessageManager = new MicromessageManager();
            List<MicroMessageData> microMessageDataList = micromessageManager.GetReplyList(messageId);

            uxMicroMessageDataListView.Visible = true;
            uxMicroMessageDataListView.DataSource = microMessageDataList;
            uxMicroMessageDataListView.DataBind();

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

GetSearchList

GetSearchList(System.String, System.Int64)

Retrieves the search results.

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

  • * Search Text
  • * Records per page

Parameters

  • searchText. The text string to search.
  • paging. The paging object. Setting RecordsPerPage = 0 retrieves all rows.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxSearchTextLabel" AssociatedControlID="uxSearchText" CssClass="span-4 last" runat="server" Text="* Search Text:" />
        <ektronUI:TextField ID="uxSearchText" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxRecordsLabel" AssociatedControlID="uxRecords" CssClass="span-4 last" runat="server" Text="* Records per page:" />
        <ektronUI:TextField ID="uxRecords" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="10" />
    </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="uxMicroMessageDataListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Id
                    </th>
                    <th>
                        User Id
                    </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("Id")%>
            </td>
            <td class="devsite-method">
                <%# Eval("UserId")%>
            </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
        {
            PagingInfo pagingInfo = new PagingInfo();
            pagingInfo.RecordsPerPage = int.Parse(uxRecords.Text);

            MicromessageManager micromessageManager = new MicromessageManager();
            List<MicroMessageData> microMessageDataList = micromessageManager.GetSearchList(uxSearchText.Text, pagingInfo);

            uxMicroMessageDataListView.Visible = true;
            uxMicroMessageDataListView.DataSource = microMessageDataList;
            uxMicroMessageDataListView.DataBind();

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

GetUserMessageList

GetUserMessageList(System.Int64,Ektron.Cms.PagingInfo)

Retrieves a list of sent user messages that the requesting user has permission to see.

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

  • * User ID

Parameters

  • paging. The paging object. Setting RecordsPerPage = 0 retrieves all rows.
  • userId. ID for which to get message list.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-6 last" runat="server" Text="* User Id:" />
        <ektronUI:TextField ID="uxUserId" 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="uxMicroMessageDataListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Id
                    </th>
                    <th>
                        User Id
                    </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("Id")%>
            </td>
            <td class="devsite-method">
                <%# Eval("UserId")%>
            </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.Common;
using Ektron.Cms.Framework.Community;
using Ektron.Cms;

.aspx.cs code-behind method

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

            PagingInfo pagingInfo = new PagingInfo();
            pagingInfo.RecordsPerPage = 10;

            MicromessageManager micromessageManager = new MicromessageManager();
            List<MicroMessageData> microMessageDataList = micromessageManager.GetUserMessageList(userId, pagingInfo);

            uxMicroMessageDataListView.Visible = true;
            uxMicroMessageDataListView.DataSource = microMessageDataList;
            uxMicroMessageDataListView.DataBind();

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

IsFullTextSearchInstalled

IsFullTextSearchInstalled

Checks whether full text search is installed on the database. This method has no parameters.

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.

.aspx code snippet

<ol class="formFields">
<li class="clearfix">
<ektronUI:Button id="uxSubmit" runat="server" 
 OnClick="uxSubmit_Click" Text="IsFullTextSearchInstalled">
</ektronUI:Button>
</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
        {
            MicromessageManager micromessageManager = new MicromessageManager();
            bool isFullTextSearchInstalled = micromessageManager.IsFullTextSearchInstalled();

            MessageUtilities.UpdateMessage(uxMessage, "Is Full Text Search Installed: " + isFullTextSearchInstalled.ToString(), Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

IsSpam

IsSpam(Ektron.Cms.Common.EkEnumeration.MicroMessageSpamControlType,System.Int32,Ektron.Cms.MicroMessageData)

Checks whether a micro-message is spam.

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
  • * Spam Timespan

Parameters

  • spamControlType. SpamControlType
  • SpamTimeSpan. SpamTimeSpan
  • data. Data

.aspx code snippet

<ol class="formFields">
        <li class="clearfix">
            <ektronUI:Label ID="uxMessageIdLabel" AssociatedControlID="uxMessageId" CssClass="span-3 last" runat="server" Text="* Id :" />
            <ektronUI:TextField ID="uxMessageId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" text="0"/>
        </li>
        <li class="clearfix">
            <ektronUI:Label ID="uxSpamTimeSpanLabel" AssociatedControlID="uxSpamTimeSpan" CssClass="span-3 last" runat="server" Text="* SpamTimeSpan :" />
            <ektronUI:TextField ID="uxSpamTimeSpan" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" text="5"/>
        </li>
        <li class="clearfix">
            <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="IsSpam"></ektronUI:Button>
            <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
        </li> 
    </ol>
</div>
</asp:View>
<asp:View ID="uxViewMessage" runat="server">
<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Message ID="uxMessage" DisplayMode="Information" Visible="false" runat="server" />
    </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 messageId = long.Parse(uxMessageId.Text);

            MicromessageManager micromessageManager = new MicromessageManager();
            MicroMessageData microMessageData = micromessageManager.GetItem(messageId);

            if (microMessageData != null)
            {
                bool isSpam = micromessageManager.IsSpam(Ektron.Cms.Common.EkEnumeration.MicroMessageSpamControlType.SameUserTimeDelay, int.Parse(uxSpamTimeSpan.Text), microMessageData);

                if (isSpam)
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Message is IsSpam", Message.DisplayModes.Success);
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Message is Not a IsSpam", Message.DisplayModes.Success);
                }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Message 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

MicroMessageCriteria

Namespace

Ektron.Cms

Constructors

  • MicroMessageCriteria()
    public MicroMessageCriteria()
  • MicroMessageCriteria(Ektron.Cms.MicroMessageProperty, EkEnumeration.OrderByDirection)
    public MicroMessageCriteria(Ektron.Cms.MicroMessageProperty
  orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the MicroMessageProperty are:

    • Avatar
    • DateCreated
    • DateModified
    • DisplayName
    • EmailAddress
    • FirstName
    • LastName
    • MessaseId
    • ParentMessageId
    • ReplyCount
    • SiteId
    • UserId
    • UserName

MicroMessageData

Namespace

Ektron.Cms

Properties

  • AllowDelete. Gets or sets the AllowDelete for this micromessage.
    public bool AllowDelete { set; get; }
  • DateCreated. Gets or sets the DateCreated for this micromessage.
    public System.DateTime DateCreated { set; get; }
  • DateModified. Gets or sets the DateModified for this micromessage.
    public System.DateTime DateModified { set; get; }
  • DisplayName. Gets or sets the DisplayName for this micromessage.
    public string DisplayName { set; get; }
  • DisplayUserName. Gets or sets the DisplayUserName for this micromessage.
    public string DisplayUserName { set; get; }
  • HasReplies. Gets if this micromessage has replies.
    public bool HasReplies { get; }
  • Id. Gets or sets the Id for this micromessage.
    public long Id { set; get; }
  • IsReply. Gets if this micromessage is a reply.
    private bool IsReply { get; }
  • MessageText. Gets or sets the MessageText for this micromessage.
    public string MessageText { set; get; }
  • ParentMessageId. Gets or sets the ParentMessageId for this micromessage.
    public long ParentMessageId { set; get; }
  • ReplyCount. Gets or sets the ReplyCount for this micromessage.
    public int ReplyCount { set; get; }
  • SiteId. Gets or sets the SiteId for this micromessage.
    public long SiteId { set; get; }
  • TimeLapse. Gets or sets the TimeLapse for this micromessage.
    public string TimeLapse { set; get; }
  • UserAvatar. Gets or sets the UserAvatar for this micromessage.
    public string UserAvatar { set; get; }
  • UserEmailAddress. Gets or sets the UserEmailAddress for this micromessage.
    public string UserEmailAddress { set; get; }
  • UserFirstName. Gets or sets the UserFirstName for this micromessage.
    public string UserFirstName { set; get; }
  • UserId. Gets or sets the UserId for this micromessage.
    public long UserId { set; get; }
  • UserLastname. Gets or sets the UserLastName for this micromessage.
    public string UserLastname { set; get; }
  • Username. Gets or sets the UserName for this micromessage.
    public string UserName { set; get; }