NotificationManager

Constructors

NotificationManager()
NotificationManager(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.
IsNotificationReplyMessagePrepended. Gets setting indicating if the Notification Email Reply message should be prepended to the notification email.
NotificationService. Notification 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

Send (activity data). Sends notifications based upon the supplied activity.

Send (activity data)

Send(Ektron.Cms.Activity.ActivityData)

Sends notifications based upon the supplied activity.

Authenticated users

CMS Administrators
Users that have access permission

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

Fields

*=Required

* Content ID
* Activity Message

Parameters

activity. The ActivityData object that has occurred and will result in notifications being sent. The Activity.Message property is ignored and is retrieved based upon CMS message settings.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxContentIDLabel" AssociatedControlID="uxContentID" CssClass="span-4 last"
            runat="server" Text="*Content ID :" />
        <ektronUI:TextField ID="uxContentID" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="30" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxMesageLabel" AssociatedControlID="uxActivityMessage" CssClass="span-4 last"
            runat="server" Text="*Activity Message :" />
        <ektronUI:TextField ID="uxActivityMessage" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="A New Content is added" />
    </li>
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Send"></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.Notifications;
using Ektron.Cms.Activity;
using Ektron.Cms.Framework.Activity;
using Ektron.Cms.Framework.Content;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            NotificationManager notificationManager = new NotificationManager();
            ActivityManager activityManager = new ActivityManager();
            ContentManager contentManager = new ContentManager();
            long contentid = Convert.ToInt64(uxContentID.Text);
            //Check the Content Details
            ContentData contentData = contentManager.GetItem(contentid);
            if (contentData != null)
            {
                ActivityUserInfo userInfo = new ActivityUserInfo();
                userInfo.Id = contentData.UserId;
                //Set the Activity Details
                ActivityData activityData = new ActivityData()
                {
                    ActivityTypeId = 0,
                    ActionUser = userInfo,
                    Message = uxActivityMessage.Text,
                    ObjectId = contentid,
                    Date = DateTime.Now,
                    LanguageId = 1033
                };
                //Add a New Activity with given activityDetails.
                activityManager.Add(activityData);
                //Send notification based upon the supplied activity. 
                notificationManager.Send(activityData);
                MessageUtilities.UpdateMessage(uxMessage, "Successfully Sent a Notification Based upon the Supplied Activity.", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid Content ID and Try again.", Message.DisplayModes.Error);
            }

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

    }

Send (message data). Sends notifications based upon the supplied notification message data.

Send (message data)

Send(Ektron.Cms.Notifications.NotificationMessageData)

Sends notifications based upon the supplied notification message data.

Authenticated users

CMS Administrators
Users that have access permission

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

Fields

*=Required

* Content ID
* Subject
* Activity Message
* User ID

Parameters

notificationMessage. NotificationMessageData object defining message to send and the user to whom to send it.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxContentIDLabel" AssociatedControlID="uxContentID" CssClass="span-4 last"
            runat="server" Text="*Content ID :" />
        <ektronUI:TextField ID="uxContentID" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="30" />
    </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"
            Text="New ontrek Notification" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxMesageLabel" AssociatedControlID="uxActivityMessage" CssClass="span-4 last"
            runat="server" Text="*Activity Message :" />
        <ektronUI:TextField ID="uxActivityMessage" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="A New Content is added" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-4 last"
            runat="server" Text="*User Id:" />
        <ektronUI:TextField ID="uxUserId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="1" />
    </li>
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Send"></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.Notifications;
using Ektron.Cms.Activity;
using Ektron.Cms.Framework.Activity;
using Ektron.Cms.Framework.Content;
using Ektron.Cms.Notifications;
using Ektron.Cms.Framework.User;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            NotificationManager notificationManager = new NotificationManager();
            ActivityManager activityManager = new ActivityManager();

            UserManager Usermanager = new UserManager();
            long UserId = long.Parse(uxUserId.Text);

            ContentManager contentManager = new ContentManager();
            long contentid = Convert.ToInt64(uxContentID.Text);
            //Check the Content Details
            ContentData contentData = contentManager.GetItem(contentid);
            if (contentData != null)
            {   //Check Whether Entered UserID valid or Not
                UserData Userdata = Usermanager.GetItem(UserId);
                if (Userdata != null)
                {
                    ActivityUserInfo userInfo = new ActivityUserInfo();
                    userInfo.Id = contentData.UserId;
                    //Set the Activity Details
                    ActivityData activityData = new ActivityData()
                    {
                        ActivityTypeId = 0,
                        ActionUser = userInfo,
                        Message = uxActivityMessage.Text,
                        ObjectId = contentid,
                        Date = DateTime.Now,
                        LanguageId = 1033
                    };
                    //Add a New Activity with given activityDetails.
                    activityManager.Add(activityData);
                    UserNotificationData userNotificationData = new UserNotificationData();
                    userNotificationData.User = Userdata;

                    //AgentName is a Default value which is taken from the web.config file under notificationAgent/providers section
                    userNotificationData.AgentName = "EktronEmail";
                    string message = uxActivityMessage.Text + "<p> Content ID is " + contentData.Id + "</p><p><a href=http://" + Request.Headers["host"] + contentData.Quicklink + ">" + contentData.Title + "</a> </p>";
                    NotificationMessageData notificationMessageData = new NotificationMessageData()
                    {
                        HtmlMessage = message,
                        Subject = uxSubject.Text,
                        UserNotification = userNotificationData,
                        TextMessage = uxActivityMessage.Text,
                        DocumentTitle = contentData.Title,
                        Activity = activityData,
                        Document = null,
                    };
                    //Send notification based upon the supplied notification Message Data. 
                    notificationManager.Send(notificationMessageData);
                    MessageUtilities.UpdateMessage(uxMessage, "Successfully Sent a Notification Based upon the Supplied Activity.", 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 Content 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

Data Classes

ActivityData

Namespace

Ektron.Cms.Activity

Properties

ActionUser. Gets or sets the user who caused this activity to occur. For example, the user who posted a blog post or uploaded a document.
```
public Ektron.Cms.Activity.ActivityUserInfo ActionUser { set; get; }
```
ActivityData()
```
public ActivityData()
```

ActivityData(long, long, long)

public ActivityData(long activityTypeId, long objectId,
  long actionUserId)

ActivityData(long, long, long, int, string)

public ActivityData(long activityTypeId, long objectId,
  long actionUserId, int languageId, string message)

ActivityTypeId. Gets or sets the ActivityType for this Activity. Built in CMS Activity are defined in EkEnumeration.ActivityType.
```
public long ActivityTypeId { set; get; }
```
CanComment. Gets or sets the CanComment permissions for the activity.
```
public bool CanComment { set; get; }
```
CommentCount. Gets or sets the Comment count for the activity.
```
public int CommentCount { set; get; }
```
Comments. Gets or sets the Comments for the activity. This property will not be populated unless explicitly specified when calling API. To get the total comment count, see CommentCount property.
```
public System.Collections.ObjectModel.Collection<ActivityCommentData> 
  Comments { set; get; }
```
Date. Gets or sets the date the activity occurred.
```
public System.DateTime Date { set; get; }
```
Id. Gets or set the ID of the activity.
```
public long Id { set; get; }
```
LanguageId. Gets or sets the language associated with this activity's message.
```
public int LanguageId { set; get; }
```
Message. Gets or sets the message for this activity.
```
public string Message { set; get; } 
```
ObjectId. Gets or sets the ID of the object associated with this activity.
```
public long ObjectId { set; get; }
```
ScopeObjectId. Gets or sets the ID of the scope object associated with this activity.
```
public long ScopeObjectId { set; get; }
```
SiteId. Gets or sets the ID of the site that the activity originated from.
```
public long SiteId { set; get; }
```
TimeLapse. Gets the time lapse for the activity.
```
public string TimeLapse { set; get; }
```
UniqueId. Gets or sets the unique ID for the activity.
```
public System.Guid UniqueId { set; get; }
```
Validate(). Validates the current ActivityData instance is in a valid state for saving. Returns collection of validation errors if not valid.
```
public ValidationResults Validate()
```

NotificationMessageData

Namespace

Ektron.Cms.Notifications

Properties

Activity. Gets or sets the Activity associated with the notification. This may be required for some notifications, but not all. The ActivityFeed, for one, provider requires it.
```
public Ektron.Cms.Activity.ActivityData Activity { set; get; }
```
Document. Gets or sets the document associated with the notification message. May be null.
```
public byte[] Document { set; get; }
```
DocumentTitle. Gets or sets the document title associated with the notification message. May be null.
```
public string DocumentTitle { set; get; }
```
HtmlMessage. Gets or sets the HTML message of the notification. This message would be used by providers that support HTML based messages.
```
public string HtmlMessage { set; get; }
```
NotificationMessageData()
```
public NotificationMessageData()
```

NotificationMessageData(string, string, string, Ektron.Cms.Notifications.UserNotificationData)

public NotificationMessageData(string htmlMessage,
  string textMessage, string subject,
  Ektron.Cms.Notifications.UserNotificationData userNotification)

NotificationMessageData(string, string, string, Ektron.Cms.Notifications.UserNotificationData, Ektron.Cms.Activity.ActivityData)

public NotificationMessageData(string htmlMessage,
  string textMessage, string subject,
  Ektron.Cms.Notifications.UserNotificationData
  userNotification, Ektron.Cms.Activity.ActivityData activity)

Subject. Gets or sets the subject of the notification.
```
public string Subject { set; get; }
```
TextMessage. Gets or sets the text message of the notification. This message would be used by providers that send messages in plain text and not HTML.
```
public string TextMessage { set; get; }
```

UserNotification. Gets or sets the UserNotificationData for this notification.

public Ektron.Cms.Notifications.UserNotificationData
  UserNotification { set; get; }