UserNotificationSettingManager

The UserNotificationSettingManager class manages user-specified notifications. UserNotificationSettigns are user settings per notification agent. For example, to receive notifications via email, the user would need to provide his or her email address, and so on.

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

Namespace

Ektron.Cms.Framework.Settings.Notifications.UserNotificationSettingManager

Constructors

  • UserNotificationSettingManager()
  • UserNotificationSettingManager(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.
  • RequestInformation. Gets information about the current request.
  • SitePath. Gets the site path.
  • UserId. Gets or sets the ID of the currently logged-in user.
  • UserSettingService. User setting service.

Methods

Add

Add(Ektron.Cms.UserNotificationSettingData)

Adds a UserNotificationSettingData 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

  • * User ID
  • * Agent ID
  • Enable
  • Verification Code

Parameters

  • userSettingData. User setting data to save.

Returns

Returns the custom CmsData object added.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-4 last"
            runat="server" Text="*UserId :" />
        <ektronUI:TextField ID="uxUserId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="1" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxAgentIdLabel" AssociatedControlID="uxAgentId" CssClass="span-4 last"
            runat="server" Text="*AgentId :" />
        <ektronUI:TextField ID="uxAgentId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="2" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIsEnableLabel" AssociatedControlID="uxIsEnable" CssClass="span-4 last"
            runat="server" Text="Enable :" />
        <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="uxVerificationCodeLabel" AssociatedControlID="uxVerificationCode"
            CssClass="span-4 last" runat="server" Text="Verification Code:" />
        <ektronUI:TextField ID="uxVerificationCode" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="" />
    </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;
using Ektron.Cms.Framework.User;
using Ektron.Cms.Notifications.Provider;

.aspx.cs code-behind method

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

            NotificationAgentSettingManager notificationAgentSettingManager = new NotificationAgentSettingManager();
            long NotificationAgentID = long.Parse(uxAgentId.Text);
            //Check  Whether NotificationAgentID valid or Not
            NotificationAgentData notificationAgentData = notificationAgentSettingManager.GetItem(NotificationAgentID);
            if (notificationAgentData != null)
            {
                UserManager Usermanager = new UserManager();
                long UserId = long.Parse(uxUserId.Text);
                //Check Whether Entered UserID Valid or Not
                UserData Userdata = Usermanager.GetItem(UserId);
                if (Userdata != null)
                {
                    NotificationAgent agent = NotificationAgentManager.Providers[notificationAgentData.Name];
                    //Get the Agent Settings Data.
                    NotificationAgentSettingsData notificationAgentSettingsData = agent.GetAgentSettings();
                    //Set User Notification Setting with given Details
                    UserNotificationSettingData userNotificationSettingData = new UserNotificationSettingData()
                    {
                        AgentId = NotificationAgentID, //AgentId =2 is for 'Activity Stream.'
                        UserId = long.Parse(uxUserId.Text),
                        IsEnabled = status,
                        VerificationCode = uxVerificationCode.Text != string.Empty ? uxVerificationCode.Text : null,
                        AgentSettings = notificationAgentSettingsData,

                    };
                    userNotificationSettingManager.Add(userNotificationSettingData);

                    MessageUtilities.UpdateMessage(uxMessage, "User Notification Setting Saved with Id " + userNotificationSettingData.Id, Message.DisplayModes.Success);
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid User Id and Try again.", 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);
        }
    }

Delete

Delete(System.Int64)

Deletes a user notification setting 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

  • * User Setting ID

Parameters

Remarks

Validate the item with GetItem() before deleting it.

.aspx code snippet

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

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            UserNotificationSettingManager userNotificationSettingManager = new UserNotificationSettingManager();
            //Check whether Entered UserSettingId is Valid or Not
            long UserSettingId = long.Parse(uxUserSettingId.Text);
            UserNotificationSettingData userNotificationSettingData = userNotificationSettingManager.GetItem(UserSettingId);
            if (userNotificationSettingData != null)
            {   //Delete a given User Notification Setting from the CMS.
                userNotificationSettingManager.Delete(UserSettingId);
                MessageUtilities.UpdateMessage(uxMessage, "User Notification Setting  with Id " + UserSettingId + " has been Deleted from the CMS", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter a Valid User Notification Settings Id ", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetItem

GetItem(Ektron.Cms.UserNotificationSettingData)

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

  • * User Setting ID

Parameters

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUserSettingIdLabel" AssociatedControlID="uxUserSettingId" CssClass="span-4 last"
            runat="server" Text="*UserSetting Id :" />
        <ektronUI:TextField ID="uxUserSettingId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>                  
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetItem"></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="uxUserId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxIsEnabled" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxVerificationCode" 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;
using Ektron.Cms.Framework.User;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            UserNotificationSettingManager userNotificationSettingManager = new UserNotificationSettingManager();
            //Check whether Entered UserSettingId is Valid or Not
            long UserSettingId = long.Parse(uxUserSettingId.Text);
            UserNotificationSettingData userNotificationSettingData = userNotificationSettingManager.GetItem(UserSettingId);
            if (userNotificationSettingData != null)
            {    //Display the User Notification Setting Details.
                MessageUtilities.UpdateMessage(uxMessage, "User Notification Setting with Id " + UserSettingId + " Details are below:", Message.DisplayModes.Success);

                uxAgentID.Text = "Agent Id : " + userNotificationSettingData.AgentId;
                uxUserId.Text = "User Id : " + userNotificationSettingData.UserId;
                uxIsEnabled.Text = "IsEnabled : " + userNotificationSettingData.IsEnabled;
                uxVerificationCode.Text = "Verification Code : " + userNotificationSettingData.VerificationCode;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter a Valid User Notification Settings Id ", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetList

GetList(Ektron.Cms.Notifications.UserNotificationSettingCriteria)

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

  • User Notification Setting 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="uxUserNotificationSettingPropertyLabel" AssociatedControlID="uxUserNotificationSettingProperty"
            CssClass="span-5 last" runat="server" Text="UserNotification Setting Property :" />
        <asp:DropDownList ID="uxUserNotificationSettingProperty" runat="server">
            <asp:ListItem>UserId</asp:ListItem>
            <asp:ListItem>Id</asp:ListItem>
            <asp:ListItem>AgentId</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="uxNotificationSettingListView" 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>
                        UserId
                    </th>
                    <th>
                        AgentId
                    </th>
                    <th>
                        IsEnabled
                    </th>
                    <th>
                        VerificationCode
                    </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("AgentId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("IsEnabled ")%>
            </td>
            <td class="devsite-method">
                <%# Eval("VerificationCode")%>
            </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.Framework.User;
using Ektron.Cms.Common;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            UserNotificationSettingManager userNotificationSettingManager = new UserNotificationSettingManager();
            object Objectvalue;
            string Property = uxUserNotificationSettingProperty.SelectedItem.Text;
            Objectvalue = Convert.ToInt64(uxObjectValue.Text);

            UserNotificationSettingCriteria criteria = new UserNotificationSettingCriteria(UserNotificationSettingProperty.Id, EkEnumeration.OrderByDirection.Ascending);
            if (Property == "Id")
            {
                criteria.AddFilter(UserNotificationSettingProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (Property == "UserId")
            {
                criteria.AddFilter(UserNotificationSettingProperty.UserId, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                criteria.AddFilter(UserNotificationSettingProperty.AgentId, CriteriaFilterOperator.EqualTo, Objectvalue);
            }

            List<UserNotificationSettingData> NotificationSettingList = userNotificationSettingManager.GetList(criteria);

            uxNotificationSettingListView.Visible = true;
            uxNotificationSettingListView.DataSource = NotificationSettingList;
            uxNotificationSettingListView.DataBind();

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

Update

Update(Ektron.Cms.Common.CustomPropertyData)

Updates an existing UserNotificationSettingData object item in the CMS.

Authenticated users

  • CMS Administrators

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

Fields

*=Required

  • * User Setting ID
  • User ID
  • Agent ID
  • Enable
  • Verification Code

Parameters

  • userSettingData. User setting data to save.

Returns

Returns the custom CmsData object updated.

Remarks

Validate the user notification setting item with GetItem() before you update the properties. Then, call Update with your modified UserNotificationSettingData object.

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

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUserSettingIdLabel" AssociatedControlID="uxUserSettingId" CssClass="span-4 last"
            runat="server" Text="*UserSetting Id :" />
        <ektronUI:TextField ID="uxUserSettingId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-4 last"
            runat="server" Text="UserId :" />
        <ektronUI:TextField ID="uxUserId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxAgentIdLabel" AssociatedControlID="uxAgentId" CssClass="span-4 last"
            runat="server" Text="AgentId :" />
        <ektronUI:TextField ID="uxAgentId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIsEnableLabel" AssociatedControlID="uxIsEnable" CssClass="span-4 last"
            runat="server" Text="Enable :" />
        <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="uxVerificationCodeLabel" AssociatedControlID="uxVerificationCode"
            CssClass="span-4 last" runat="server" Text="Verification Code:" />
        <ektronUI:TextField ID="uxVerificationCode" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="" />
    </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;
using Ektron.Cms.Framework.User;
using Ektron.Cms.Notifications.Provider;

.aspx.cs code-behind method

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

            //Check whether Entered UserSettingId is Valid or Not
            long UserSettingId = long.Parse(uxUserSettingId.Text);
            userNotificationSettingData = userNotificationSettingManager.GetItem(UserSettingId);
            if (userNotificationSettingData != null)
            {
                UserManager Usermanager = new UserManager();
                long UserId = long.Parse(uxUserId.Text);
                if (UserId > 0)
                {
                    //Check Whether Entered UserID Valid or Not
                    UserData Userdata = Usermanager.GetItem(UserId);
                    if (Userdata != null)
                    {    //Update USER ID here
                        userNotificationSettingData.UserId = UserId;
                        update();
                    }
                    else
                    {
                        MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid User Id and Try again.", Message.DisplayModes.Error);
                    }
                }
                else { update(); }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter a Valid User Notification Settings Id ", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

VerifyValidationCode

VerifyValidationCode(System.Int64,System.String)

Verifies that the validation code is correct and enables users notfication settings.

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 Setting ID
  • * Verification Code

Parameters

  • userSettingId. ID of user notification setting.
  • verificationCode. Verification code to validate.

Returns

Returns true if the verification code is correct.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUserSettingIdLabel" AssociatedControlID="uxUserSettingId" CssClass="span-4 last"
            runat="server" Text="*UserSetting Id :" />
        <ektronUI:TextField ID="uxUserSettingId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>   
    <li class="clearfix">
        <ektronUI:Label ID="uxVerificationCodeLabel" AssociatedControlID="uxVerificationCode"
            CssClass="span-4 last" runat="server" Text="*Verification Code:" />
        <ektronUI:TextField ID="uxVerificationCode" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="" />
    </li>               
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetItem"></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>              
</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
        {
            UserNotificationSettingManager userNotificationSettingManager = new UserNotificationSettingManager();
            //Check whether Entered UserSettingId is Valid or Not
            long UserSettingId = long.Parse(uxUserSettingId.Text);
            UserNotificationSettingData userNotificationSettingData = userNotificationSettingManager.GetItem(UserSettingId);
            if (userNotificationSettingData != null)
            {
                bool status = userNotificationSettingManager.VerifyValidationCode(UserSettingId, uxVerificationCode.Text);
                if (status == true)
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Entered verification code is correct.", Message.DisplayModes.Success);
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Entered verification code is Not correct ", Message.DisplayModes.Error);
                }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter a Valid User Notification Settings Id ", Message.DisplayModes.Success);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Data Classes

UserNotificationSettingCriteria

Namespace

Ektron.Cms.Notifications

Constructors

  • UserNotificationSettingCriteria()
    public UserNotificationSettingCriteria()
  • UserNotificationSettingCriteria(Ektron.Cms.Notifications.UserNotificationSettingProperty, EkEnumeration.OrderByDirection)
    public
  UserNotificationSettingCriteria(Ektron.Cms.Notifications.UserNotificationSettingProperty
  orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the UserNotificationSettingProperty are:

    • AgentId
    • Id
    • IsEnabled
    • UserId
    • VerificationCode

UserNotificationSettingData

Namespace

Ektron.Cms.Notifications

Properties

  • AgentId. Gets or sets the ID of the Notification Agent associated with these settings.
    public long AgentId { set; get; }
  • AgentSettings. Gets or sets the user's settings for this notification provider.
    public Ektron.Cms.Notifications.NotificationAgentSettingsData
  AgentSettings { set; get; }
  • IsEnabled. Gets or sets the enabled setting for this user notification setting. This notification setting cannot be used if its not enabled.
    public bool IsEnabled { set; get; }
  • UserId. Gets or sets the user Id associated with these settings.
    public long UserId { set; get; }
  • UserNotificationSettingData()
    public UserNotificationSettingData()
  • UserNotificationSettingData(long, long, long)
    public UserNotificationSettingData(long id, long userId,
  long agentId)
  • UserNotificationSettingData(long, long, long, Ektron.Cms.Notifications.NotificationAgentSettingsData)
    public UserNotificationSettingData(long id, long userId,
  long agentId, Ektron.Cms.Notifications.NotificationAgentSettingsData
  agentSettings)
  • Validate(). Validates that the data object is valid for saving. Any errors are returns as ValidationResults.
    public ValidationResults Validate()
  • VerificationCode. Gets or sets the verificationcode for this setting. The user cannot recieve notifications on this provider until they verify this code.
    public string VerificationCode { set; get; }