PrivateMessageManager

The PrivateMessageManager class manages messages between users.

Namespace

Ektron.Cms.Framework.Community.PrivateMessageManager

Constructors

  • PrivateMessageManager()
  • PrivateMessageManager(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.
  • MessageManagerService. Returns an instance of the business objects message 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

Delete

Delete(System.Int64)

Deletes a private 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 message to delete.

Remarks

Validate the item using GetItem() before deleting.

.aspx code snippet

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

.aspx.cs code-behind method

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

            PrivateMessageManager privateMessageManager = new PrivateMessageManager();
            PrivateMessageData messageData = privateMessageManager.GetItem(privateMessageId);
            if (messageData != null)
            {
                privateMessageManager.Delete(privateMessageId);
                MessageUtilities.UpdateMessage(uxMessage, "Private message deleted", Message.DisplayModes.Success);
            }
            else 
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter a Valid PrivateMessageId", Message.DisplayModes.Error);
            }
            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 PrivateMessageData 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.

GetList

GetList(Ektron.Cms.Community.PrivateMessageCriteria)

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

  • * Return Unread Only

Parameters

  • criteria. Criteria used to retrieve messages.

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="uxObjectValueLabel" AssociatedControlID="uxUnReadOnly" CssClass="span-4 last" runat="server" Text="* Return Unread Only:" />
    <ektronUI:Button DisplayMode="Checkbox" Checked="false" Text="" ID="uxUnReadOnly" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />    
</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:ListView ID="uxMessageListListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
<EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        From
                    </th>
                    <th>
                        Subject
                    </th>
                    <th>
                        Date
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("FromUserDisplayName")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Subject")%>
            </td>
            <td class="devsite-method">
                <%# Eval("DateCreated")%>
            </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
        {
            PrivateMessageManager privateMessageManager = new PrivateMessageManager();

            if (privateMessageManager.UserId == 0)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Should be logged in to retrieve private messages.", Message.DisplayModes.Error);
                uxPageMultiView.SetActiveView(uxViewMessage);
                return;
            }

            PrivateMessageCriteria criteria = new PrivateMessageCriteria();
            criteria.AddFilter(PrivateMessageProperty.RecipientUserId, CriteriaFilterOperator.EqualTo, privateMessageManager.UserId);

            if (uxUnReadOnly.Checked)
            {
                criteria.AddFilter(PrivateMessageProperty.IsRead, CriteriaFilterOperator.EqualTo, false);
            }

            List<PrivateMessageData> messageList = privateMessageManager.GetList(criteria);

            uxMessageListListView.Visible = true;
            uxMessageListListView.DataSource = messageList;
            uxMessageListListView.DataBind();

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

MarkRead

MarkRead(System.Int64)

Marks the supplied message as read for the currently logged-in user.

NOTE: This method will not work in ApiAccessMode.Admin because a user is in charge of his or her own private 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

  • * ID

Parameters

  • messageId. ID of the message to mark as read.

.aspx code snippet

<div class="ektron-ui-form registerForm">
    <ol class="formFields">
        <li class="clearfix">
            <ektronUI:Label ID="uxPrivateMessageIdLabel" AssociatedControlID="uxPrivateMessageId" CssClass="span-3 last" runat="server" Text="* Id:" />
            <ektronUI:TextField ID="uxPrivateMessageId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
        </li>
        <li class="clearfix">
            <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Mark As Read"></ektronUI:Button>
            <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
        </li>
    </ol>
</div>

.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
        {
            long privateMessageId = long.Parse(uxPrivateMessageId.Text);

            PrivateMessageManager privateMessageManager = new PrivateMessageManager();
            PrivateMessageData messageData = privateMessageManager.GetItem(privateMessageId);

            if (messageData != null)
            {

                privateMessageManager.MarkRead(privateMessageId);

                MessageUtilities.UpdateMessage(uxMessage, "Private Message Marked Read", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Private Message does not exists. ", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

MarkUnread

MarkUnread(System.Int64)

Marks the supplied message as unread for the currently logged-in user.

NOTE: This method will not work in ApiAccessMode.Admin because a user is in charge of his or her own private 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

  • * ID

Parameters

  • messageId. ID of the message to mark as read.

.aspx code snippet

<div class="ektron-ui-form registerForm">
    <ol class="formFields">
        <li class="clearfix">
            <ektronUI:Label ID="uxPrivateMessageIdLabel" AssociatedControlID="uxPrivateMessageId" CssClass="span-3 last" runat="server" Text="* Id:" />
            <ektronUI:TextField ID="uxPrivateMessageId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
        </li>
        <li class="clearfix">
            <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Mark As Unread"></ektronUI:Button>
            <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" /> 
        </li>
    </ol>
</div>

.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
        {
            long privateMessageId = long.Parse(uxPrivateMessageId.Text);

            PrivateMessageManager privateMessageManager = new PrivateMessageManager();
            PrivateMessageData messageData = privateMessageManager.GetItem(privateMessageId);

            if (messageData != null)
            {

                privateMessageManager.MarkUnread(privateMessageId);

                MessageUtilities.UpdateMessage(uxMessage, "Private Message Marked Read", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Private Message does not exists. ", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Send

Send(Ektron.Cms.PrivateMessageData)

Sends a private message based on the supplied PrivateMessageData object. You can add multiple recipients using PrivateMessageData.Recipients property.

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

  • * To (User ID)
  • * Subject
  • * Message

Parameters

  • messageData. The PrivateMessageData object to send.

Returns

Returns the PrivateMessageData object added.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="Label1" AssociatedControlID="uxRecipientId" CssClass="span-4 last" runat="server" Text="* To (User Id):" />
        <ektronUI:TextField ID="uxRecipientId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"  />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxSubjectLabel" AssociatedControlID="uxSubject" CssClass="span-4 last" runat="server" Text="* Subject:" />
        <ektronUI:TextField ID="uxSubject" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"  />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxTextLabel" AssociatedControlID="uxText" CssClass="span-4 last" runat="server" Text="* Message:" />
        <asp:TextBox TextMode="MultiLine" Rows="3"  ID="uxText" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Send"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /> 
    </li> 
</ol>
<ektronUI:Message ID="uxMessage" DisplayMode="Information" runat="server" />

.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
        {

            long toUserId;

            if (!long.TryParse(uxRecipientId.Text, out toUserId)){
                MessageUtilities.UpdateMessage(uxMessage, "Valid To User ID required.", Message.DisplayModes.Error);
                return;
            }

            PrivateMessageManager privateMessageManager = new PrivateMessageManager();
            PrivateMessageData privateMessageData = new PrivateMessageData()
            {
                Subject = uxSubject.Text, 
                Message = uxText.Text 
            };

            privateMessageData.AddRecipient(new PrivateMessageRecipientData() { ToUserID = toUserId });

            privateMessageManager.Send(privateMessageData);

            MessageUtilities.UpdateMessage(uxMessage, "Private Message added with ID : " + privateMessageData.Id, Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Data Classes

PrivateMessageData

Namespace

Ektron.Cms

Properties

  • AddRecipient(Ektron.Cms.PrivateMessageRecipientData)
    public void AddRecipient(Ektron.Cms.PrivateMessageRecipientData Recipient)
  • DateCreated
    public System.DateTime DateCreated { set; get; }
  • Ext_Values
    public int Ext_Values { set; get; }
  • FolderId
    public long FolderID { set; get; }
  • FromUserDeleted
    public bool FromUserDeleted { set; get; }
  • FromUserDisplayName
    public string FromUserDisplayName { set; get; }
  • FromUserID
    public long FromUserID { set; get; }
  • ID
    public long ID { set; get; }
  • Message
    public string Message { set; get; }
  • Recipients
    public Ektron.Cms.PrivateMessageRecipientData[] Recipients { set; get; }
  • SetID(long)
    public void SetID(long id)
  • Subject
    public string Subject { set; get; }