CmsMessageTypeManager

The CmsMessageTypeManager class manages message types in the Ektron CMS.

Namespace

Ektron.Cms.Framework.Settings.CmsMessageTypeManager

Constructors

  • CmsMessageTypeManager()
  • CmsMessageTypeManager(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.
  • MessageTypeService. Gets instance to ICmsMessageType.
  • 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.Messaging.CmsMessageTypeData)

Adds a message type based on information in a CmsMessageTypeData object. The method populates the message.Id with the newly created ID.

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

  • * Name
  • * Scope

Parameters

Returns

Returns the custom CmsData object added.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxNameLabel" AssociatedControlID="uxName" CssClass="span-3 last" runat="server" Text="* Name:" />
        <ektronUI:TextField  ID="uxName" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" /> 
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxScopeLabel" AssociatedControlID="uxScope" CssClass="span-3 last" runat="server" Text="* Scope:" />
        <ektronUI:TextField  ID="uxScope" CssClass="span-4" 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-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.Messaging;
using Ektron.Cms.Framework.Settings;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            CmsMessageTypeManager cmsMessageTypeManager = new CmsMessageTypeManager();
            CmsMessageTypeData cmsMessageTypeData = new CmsMessageTypeData()
            {
                 Name = uxName.Text ,
                 Scope = uxScope.Text 
            };

            cmsMessageTypeManager.Add(cmsMessageTypeData);

            MessageUtilities.UpdateMessage(uxMessage, "Message Type added with Id " + cmsMessageTypeData.Id, 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 message type (CmsMessageTypeData object) 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 with GetItem() before deleting it.

.aspx code snippet

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

.aspx.cs code-behind method

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

            CmsMessageTypeManager cmsMessageTypeManager = new CmsMessageTypeManager();
            CmsMessageTypeData cmsMessageTypeData = cmsMessageTypeManager.GetItem(messageTypeId);

            if (cmsMessageTypeData != null)
            {
                cmsMessageTypeManager.Delete(messageTypeId);
                MessageUtilities.UpdateMessage(uxMessage, "Message Type deleted.", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Message Type does not exists.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetItem

GetItem(Ektron.Cms.CmsMessageTypeData)

Retrieves the properties of a specific CmsMessageTypeData 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 type to retrieve.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageTypeIdLabel" AssociatedControlID="uxMessageTypeId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxMessageTypeId" 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="uxScope" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxName" 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.Messaging;
using Ektron.Cms.Framework.Settings;

.aspx.cs code-behind method

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

            CmsMessageTypeManager cmsMessageTypeManager = new CmsMessageTypeManager();
            CmsMessageTypeData cmsMessageTypeData = cmsMessageTypeManager.GetItem(messageTypeId);

            if (cmsMessageTypeData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for message with ID " + cmsMessageTypeData.Id.ToString() + " are below", Message.DisplayModes.Success);

                uxScope.Text = "Scope : " + cmsMessageTypeData.Scope;
                uxName.Text = "Name : " + cmsMessageTypeData.Name;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Message Type 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(CmsMessageTypeCriteria)

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

  • CMS Message Type 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.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCmsMessageTypePropertyLabel" AssociatedControlID="uxCmsMessageTypeProperty" CssClass="span-6 last" runat="server" Text="CmsMessageTypeProperty:" />
        <asp:DropDownList ID="uxCmsMessageTypeProperty" runat="server">
            <asp:ListItem>Name</asp:ListItem>
            <asp:ListItem>Scope</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" />
    </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="uxCmsMessageTypeDataListView" 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>
                        Name
                    </th>
                    <th>
                        Scope
                    </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("Name")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Scope")%>
            </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.Messaging;
using Ektron.Cms.Framework.Settings;

.aspx.cs code-behind method

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

            CmsMessageTypeCriteria criteria = new CmsMessageTypeCriteria(CmsMessageTypeProperty.Id, EkEnumeration.OrderByDirection.Descending);
            if (uxCmsMessageTypeProperty.SelectedItem.Text == "Name")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(CmsMessageTypeProperty.Name , CriteriaFilterOperator.Contains , Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(CmsMessageTypeProperty.Scope , CriteriaFilterOperator.Contains, Objectvalue);
            }

            CmsMessageTypeManager cmsMessageTypeManager = new CmsMessageTypeManager();
            List<CmsMessageTypeData> cmsMessageDataList = cmsMessageTypeManager.GetList(criteria);

            uxCmsMessageTypeDataListView.Visible = true;
            uxCmsMessageTypeDataListView.DataSource = cmsMessageDataList;
            uxCmsMessageTypeDataListView.DataBind();

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

GetTokenList

GetTokenList(System.Int64)

Retrieves the list of applicable replacement tokens for a message type ID.

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

  • messageTypeId. ID of the message type to retrieve tokens for.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageTypeIdLabel" AssociatedControlID="uxMessageTypeId" CssClass="span-6 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxMessageTypeId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Token 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="uxTokenListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Token
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Container.DataItem %>  
            </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.Framework.Settings;

.aspx.cs code-behind method

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

            CmsMessageTypeManager cmsMessageTypeManager = new CmsMessageTypeManager();
            List<string> TokenList = cmsMessageTypeManager.GetTokenList(messageTypeId);

            uxTokenListView.Visible = true;
            uxTokenListView.DataSource = TokenList;
            uxTokenListView.DataBind();

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

Update

Update(Ektron.Cms.CmsMessageTypeData)

Updates an existing CmsMessageTypeData object 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

  • * ID
  • Name
  • Scope

Parameters

Returns

Returns the custom CmsData object updated.

Remarks

Validate the CmsMessageType item with GetItem() before you update the properties. Then, call Update with your modified CmsMessageTypeData object.

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

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxMessageTypeIdLabel" AssociatedControlID="uxMessageTypeId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxMessageTypeId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxNameLabel" AssociatedControlID="uxName" CssClass="span-3 last" runat="server" Text=" Name:" />
        <ektronUI:TextField  ID="uxName" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" /> 
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxScopeLabel" AssociatedControlID="uxScope" CssClass="span-3 last" runat="server" Text=" Scope:" />
        <ektronUI:TextField  ID="uxScope" CssClass="span-4" 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-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.Settings;
using Ektron.Cms.Messaging;

.aspx.cs code-behind method

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

            CmsMessageTypeManager cmsMessageTypeManager = new CmsMessageTypeManager();
            CmsMessageTypeData cmsMessageTypeData = cmsMessageTypeManager.GetItem(messageTypeId);

            if (cmsMessageTypeData != null)
            {
                cmsMessageTypeData.Scope = uxScope.Text != string.Empty ? uxScope.Text : cmsMessageTypeData.Scope;
                cmsMessageTypeData.Name = uxName.Text != string.Empty ? uxName.Text : cmsMessageTypeData.Name;

                cmsMessageTypeManager.Update(cmsMessageTypeData);

                MessageUtilities.UpdateMessage(uxMessage,  "Message Type updated.", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Message Type 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

CmsMessageTypeCriteria

Namespace

Ektron.Cms.Messaging

Constructors

  • CmsMessageTypeCriteria()
    public CmsMessageTypeCriteria()
  • CmsMessageTypeCriteria(Ektron.Cms.Messaging.CmsMessageTypeProperty, EkEnumeration.OrderByDirection)
    public CmsMessageTypeCriteria(Ektron.Cms.Messaging.CmsMessageTypeProperty
  orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the CmsMessageTypeProperty are:

    • Id
    • Name
    • Scope

CmsMessageTypeData

Namespace

Ektron.Cms.Messaging

Properties

  • Id
    public long Id { set; get; }
  • Name. Gets or sets the name of the message type.
    public string Name { set; get; }
  • Scope. Gets or sets the scope of the message type.
    public string Scope { set; get; }
  • Validate(). Validates that the data object is in a valid state for persisting and returns a collection of ValidationResult messages if the object is not valid.
    public override ValidationResults Validate()