NotificationAgentSettingManager

The NotificationAgentSettingManager class manages notification agents.

A notification agent is a plug-able component that sends notification messages. Each Agent is responsible for sending notifications to users when CMS activity occurs. After a Notification Agent is created and registered, users can set up notification preferences that use it.

For information about notifications, see Sending Notifications to a Community in the Ektron Reference.

Namespace

Ektron.Cms.Framework.Settings.Notifications.NotificationAgentSettingManager

Constructors

  • NotificationAgentSettingManager()
  • NotificationAgentSettingManager(ApiAccessMode)

Properties

  • AgentSettingService. Notification Agent Service
  • 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.
  • 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.Notifications.NotificationAgentData)

Adds a notification agent with details from the supplied NotificationAgentData 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

  • * Name
  • * Description
  • Enable Agent
  • * Type Name

Parameters

  • agentData. Agent settings to save.

Returns

Returns the custom CmsData object added.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxNameLabel" AssociatedControlID="uxName" CssClass="span-4 last"
            runat="server" Text="*Name :" />
        <ektronUI:TextField ID="uxName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxDescriptionLabel" AssociatedControlID="uxDescription" CssClass="span-4 last"
            runat="server" Text="*Description :" />
        <ektronUI:TextField ID="uxDescription" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIsEnableLabel" AssociatedControlID="uxIsEnable" CssClass="span-4 last"
            runat="server" Text="Enable Agent:" />
        <asp:DropDownList ID="uxIsEnable" runat="server" CssClass="span-4 last">
            <asp:ListItem>True</asp:ListItem>
            <asp:ListItem>False</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxTypeNameLabel" AssociatedControlID="uxTypeName" CssClass="span-4 last"
            runat="server" Text="*Type Name :" />
        <asp:DropDownList ID="uxTypeName" runat="server" CssClass="span-4 last">
            <asp:ListItem Value="Ektron.Cms.Notifications.Providers.EktronEmailAgent">EktronEmail</asp:ListItem>
            <asp:ListItem Value="Ektron.Cms.Notifications.Providers.ActivityStreamAgent">ActivityStream</asp:ListItem>
            <asp:ListItem Value="Ektron.Cms.Notifications.Providers.SMSAgent">SMSAgent</asp:ListItem>
        </asp:DropDownList>
    </li>
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add"></ektronUI:Button>
    <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Settings.Notifications;
using Ektron.Cms.Notifications;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            NotificationAgentSettingManager notificationAgentSettingManager = new NotificationAgentSettingManager();
            bool status = false;
            if (uxIsEnable.SelectedValue.ToString() == "True")
                status = true;

            NotificationAgentData notificationAgentData = new NotificationAgentData()
            {
                Name = uxName.Text,
                Description = uxDescription.Text,
                IsEnabled = status,
                TypeName = uxTypeName.SelectedValue,
            };
            notificationAgentSettingManager.Add(notificationAgentData);

            MessageUtilities.UpdateMessage(uxMessage,  "Notification Agent Saved with Id " + notificationAgentData.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 notification agent 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

  • * Notification Agent ID

Parameters

  • id. ID of agent to delete.

Remarks

Validate the item with GetItem() before deleting it.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxNotificationAgentIDLabel" AssociatedControlID="uxNotificationAgentID" CssClass="span-4 last"
            runat="server" Text="*NotificationAgent ID :" />
        <ektronUI:TextField ID="uxNotificationAgentID" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>                  
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Delete"></ektronUI:Button>
    <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Settings.Notifications;
using Ektron.Cms.Notifications;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            NotificationAgentSettingManager notificationAgentSettingManager = new NotificationAgentSettingManager();

            long NotificationAgentID = long.Parse(uxNotificationAgentID.Text);
            //Check Whether NotificationAgentID valid or Not
            NotificationAgentData notificationAgentData = notificationAgentSettingManager.GetItem(NotificationAgentID);
            if (notificationAgentData != null)
            {  //Delete NotificationAgentID 
                notificationAgentSettingManager.Delete(NotificationAgentID);
                MessageUtilities.UpdateMessage(uxMessage, "Notification Agent  with Id " + NotificationAgentID + " has been deleted from the CMS", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid NotificationAgent ID and try again", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetAgent

GetAgent(System.Int64)

Retrieves the Notification Agent based on the Notification Agent 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

  • * Notification Agent ID

Parameters

  • id. ID of agent to retrieve.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxNotificationAgentIDLabel" AssociatedControlID="uxNotificationAgentID" CssClass="span-4 last"
            runat="server" Text="*NotificationAgent ID :" />
        <ektronUI:TextField ID="uxNotificationAgentID" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="1" />
    </li>                  
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetAgent"></ektronUI:Button>
    <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</ol>
   
    <ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxAgentID" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxNotificationAgentName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxNotificationAgentDescription" runat="server"></asp:Literal>
    </li>                
    <li class="clearfix">
        <asp:Literal ID="uxIsEnabled" 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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Settings.Notifications;
using Ektron.Cms.Notifications;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            NotificationAgentSettingManager notificationAgentSettingManager = new NotificationAgentSettingManager();

            long NotificationAgentID = long.Parse(uxNotificationAgentID.Text);
            //Check  Whether NotificationAgentID valid or Not
            NotificationAgentData notificationAgentData = notificationAgentSettingManager.GetItem(NotificationAgentID);
            if (notificationAgentData != null)
            {
                NotificationAgent notificationAgent = notificationAgentSettingManager.GetAgent(NotificationAgentID);
                if (notificationAgent != null)
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Notification Agent  Details for Id " + notificationAgentData.Id + " are below", Message.DisplayModes.Success);

                    uxAgentID.Text = "Notification Agent ID: " + notificationAgentData.Id;
                    uxNotificationAgentName.Text = "Actual Agent Name: " + notificationAgent.Name;
                    uxNotificationAgentDescription.Text = "Actual Agent Description: " + notificationAgent.Description;
                    uxIsEnabled.Text = "IsValidationRequired: " + notificationAgent.IsValidationRequired;
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage,"There is No Actual Notification Agent defined in the system for Id " + NotificationAgentID + ".", Message.DisplayModes.Error);
                }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid NotificationAgent ID and try again", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetItem

GetItem(Ektron.Cms.NotificationAgentData)

Retrieves the properties of a specific NotificationAgentData 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

  • * Notification Agent ID

Parameters

  • id. ID of agent to retrieve settings for.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxNotificationAgentIDLabel" AssociatedControlID="uxNotificationAgentID" CssClass="span-4 last"
            runat="server" Text="*NotificationAgent ID :" />
        <ektronUI:TextField ID="uxNotificationAgentID" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="1" />
    </li>                  
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Delete"></ektronUI:Button>
    <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</ol>
   
    <ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxAgentID" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxNotificationAgentName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxNotificationAgentDescription" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxNotificationAgentType" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxIsEnabled" 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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Settings.Notifications;
using Ektron.Cms.Notifications;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            NotificationAgentSettingManager notificationAgentSettingManager = new NotificationAgentSettingManager();

            long NotificationAgentID = long.Parse(uxNotificationAgentID.Text);
            //Check  Whether NotificationAgentID valid or Not
            NotificationAgentData notificationAgentData = notificationAgentSettingManager.GetItem(NotificationAgentID);
            if (notificationAgentData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Notification Agent  Details for Id " + notificationAgentData.Id + " are below", Message.DisplayModes.Success);

                uxAgentID.Text = "Notification Agent ID: " + notificationAgentData.Id;
                uxNotificationAgentName.Text = "Notification Agent Name: " + notificationAgentData.Name;
                uxNotificationAgentDescription.Text = "Notification Agent Description: " + notificationAgentData.Description;
                uxNotificationAgentType.Text = "Notification Agent TypeName: " + notificationAgentData.TypeName;
                uxIsEnabled.Text = "Notification Agent IsEnable: " + notificationAgentData.IsEnabled;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid NotificationAgent ID and try again", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetList

GetList(NotificationAgentCriteria)

Retrieves lists of objects through the GetList(NotificationAgentCriteria) 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

  • Notification Agent Property
  • * Object Value

Parameters

  • criteria. Criteria by which to retrieve agent settings.

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="uxNotificationAgentPropertyLabel" AssociatedControlID="uxNotificationAgentProperty"
            CssClass="span-5 last" runat="server" Text="NotificationAgent Property :" />
        <asp:DropDownList ID="uxNotificationAgentProperty" runat="server">
            <asp:ListItem>TypeName(EktronEmailAgent,ActivityStreamAgent,SMSAgent)</asp:ListItem>
            <asp:ListItem>Id</asp:ListItem>
            <asp:ListItem>Name</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-5 last"
            runat="server" Text="ObjectValue :" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="1" />
    </li>
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetList"></ektronUI:Button>
    <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</ol>
        
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
<asp:ListView ID="uxNotificationAgentListView" 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>
                        Description
                    </th>
                    <th>
                        TypeName
                    </th>
                    <th>
                        IsEnabled
                    </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("Description")%>
            </td>
            <td class="devsite-method">
                <%# Eval("TypeName")%>
            </td>
            <td class="devsite-method">
                <%# Eval("IsEnabled")%>
            </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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Settings.Notifications;
using Ektron.Cms.Notifications;
using Ektron.Cms.Common;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            NotificationAgentSettingManager notificationAgentSettingManager = new NotificationAgentSettingManager();
            object Objectvalue;
            string Property = uxNotificationAgentProperty.SelectedItem.Text;

            NotificationAgentCriteria criteria = new NotificationAgentCriteria(NotificationAgentProperty.Id, EkEnumeration.OrderByDirection.Ascending);
            if (Property == "Id")
            {
                Objectvalue = Convert.ToInt64(uxObjectValue.Text);
                criteria.AddFilter(NotificationAgentProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (Property == "Name")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(NotificationAgentProperty.Name, CriteriaFilterOperator.Contains, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(NotificationAgentProperty.TypeName, CriteriaFilterOperator.Contains, Objectvalue);
            }
            List<NotificationAgentData> NotificationAgentList = notificationAgentSettingManager.GetList(criteria);

            uxNotificationAgentListView.Visible = true;
            uxNotificationAgentListView.DataSource = NotificationAgentList;
            uxNotificationAgentListView.DataBind();

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

GetRegisteredAgentList

GetRegisteredAgentList

Retrieves a list of the notification agents registered in web.config.

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.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            NotificationAgentSettingManager notificationAgentSettingManager = new NotificationAgentSettingManager();
            if (uxAgentList.Checked)
            {
                List<NotificationAgent> NotificationAgentList = notificationAgentSettingManager.GetRegisteredAgentList();
                uxNotificationAgentListView.Visible = true;
                uxNotificationAgentListView.DataSource = NotificationAgentList;
                uxNotificationAgentListView.DataBind();
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage,  "Please Check the 'Get Notification Agent List' CheckBox and Try again", Message.DisplayModes.Error);
            }

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

Update

Update(Ektron.Cms.NotificationAgentData)

Updates an existing NotificationAgentData 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

  • * Notification Agent ID
  • Name
  • Description
  • Enable Agent
  • Type Name

Parameters

  • agentData. Agent settings to save.

Returns

Returns the custom CmsData object updated.

Remarks

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

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

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxNotificationAgentIDLabel" AssociatedControlID="uxNotificationAgentID" CssClass="span-4 last"
            runat="server" Text="*NotificationAgent ID :" />
        <ektronUI:TextField ID="uxNotificationAgentID" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxNameLabel" AssociatedControlID="uxName" CssClass="span-4 last"
            runat="server" Text="Name :" />
        <ektronUI:TextField ID="uxName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxDescriptionLabel" AssociatedControlID="uxDescription" CssClass="span-4 last"
            runat="server" Text="Description :" />
        <ektronUI:TextField ID="uxDescription" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIsEnableLabel" AssociatedControlID="uxIsEnable" CssClass="span-4 last"
            runat="server" Text="Enable Agent:" />
        <asp:DropDownList ID="uxIsEnable" runat="server" CssClass="span-4 last">
            <asp:ListItem>SelectOne</asp:ListItem>
            <asp:ListItem>True</asp:ListItem>
            <asp:ListItem>False</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxTypeNameLabel" AssociatedControlID="uxTypeName" CssClass="span-4 last"
            runat="server" Text="*Type Name :" />
        <asp:DropDownList ID="uxTypeName" runat="server" CssClass="span-4 last">
            <asp:ListItem Value="">SelectOne</asp:ListItem>
            <asp:ListItem Value="Ektron.Cms.Notifications.Providers.EktronEmailAgent">EktronEmail</asp:ListItem>
            <asp:ListItem Value="Ektron.Cms.Notifications.Providers.ActivityStreamAgent">ActivityStream</asp:ListItem>
            <asp:ListItem Value="Ektron.Cms.Notifications.Providers.SMSAgent">SMSAgent</asp:ListItem>
        </asp:DropDownList>
    </li>
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Update"></ektronUI:Button>
    <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Settings.Notifications;
using Ektron.Cms.Notifications;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            NotificationAgentSettingManager notificationAgentSettingManager = new NotificationAgentSettingManager();
            bool status = false;

            long NotificationAgentID = long.Parse(uxNotificationAgentID.Text);
            //Check Whether NotificationAgentID valid or Not
            NotificationAgentData notificationAgentData = notificationAgentSettingManager.GetItem(NotificationAgentID);
            if (notificationAgentData != null)
            {
                if (uxIsEnable.SelectedValue.ToString() != "SelectOne")
                {
                    if (uxIsEnable.SelectedValue.ToString() == "True")
                        status = true;
                }
                else
                {
                    status = notificationAgentData.IsEnabled;
                }
                notificationAgentData.Name = uxName.Text != string.Empty ? uxName.Text : notificationAgentData.Name;
                notificationAgentData.Description = uxDescription.Text != string.Empty ? uxDescription.Text : notificationAgentData.Description;
                notificationAgentData.TypeName = uxTypeName.SelectedValue.ToString() != string.Empty ? uxTypeName.SelectedValue.ToString() : notificationAgentData.TypeName;
                notificationAgentData.IsEnabled = status;
                //Update notificationAgentData with given Details
                notificationAgentSettingManager.Update(notificationAgentData);

                MessageUtilities.UpdateMessage(uxMessage, "Notification Agent  with Id " + notificationAgentData.Id + " has been Updated", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid NotificationAgent ID and try again", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Data Classes

NotificationAgentCriteria

Namespace

Ektron.Cms.Notifications

Constructors

  • NotificationAgentCriteria()
    public NotificationAgentCriteria()
  • NotificationAgentCriteria(Ektron.Cms.Notifications.NotificationAgentProperty, EkEnumeration.OrderByDirection)
    public NotificationAgentCriteria(Ektron.Cms.Notifications.NotificationAgentProperty
  orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the NotificationAgentProperty are:

    • Description
    • Id
    • IsEnabled
    • Name
    • TypeName

NotificationAgentData

Namespace

Ektron.Cms.Notificiations

Properties

  • NotificationAgentData()
    public NotificationAgentData()
  • NotificationAgentData(long, string, string, string, bool)
    public NotificationAgentData(long id, string name,
  string description, string typeName, bool isEnabled)
  • Validate(). Validates that the data object is valid for saving. Any errors are returns as ValidationResults.
    public ValidationResults Validate()
  • Description. Gets or sets the description of the agent.
    public string Description { set; get; }
  • Id. Get or sets the ID of the notification agent.
    public long Id { set; get; }
  • IsEnabled. Gets or sets the IsEnabled flag on the agent.
    public bool IsEnabled { set; get; }
  • Name. Gets or sets the Name of the agent.
    public string Name { set; get; }
  • TypeName. Gets or sets the fully qualified name of the agent type.
    public string TypeName { set; get; }