ActivityManager

The ActivityManager class manages user activity items that appear in the activity stream.

Namespace

Ektron.Cms.Framework.Activity.ActivityManager

Constructors

  • ActivityManager()
  • ActivityManager(ApiAccessMode)

Properties

  • ActivityService. Gets instance to IActivityStream.
  • ActivityStreamService. Gets instance to IActivityStream.
  • 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.
  • IsActivityEmailReplyEnabled. Determines whether Activity Email Replies is enabled. Use EnableActivityEmailReply and DisableActivityEmailReply to set the property.
  • IsActivityPublishingEnabled. Determines whether Activity Publishing is enabled. Use EnableActivityPublishing and DisableActivityPublishing to set the property.
  • 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

  • PurgeActivity(DateTime). Purges the activity older than given date.

Add

Add(Ektron.Cms.Activity.ActivityData)

Adds Activity data to the activity stream.

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

  • * Web Event ID
  • * Activity Type ID

Parameters

  • comment. Activity data to add.

Returns

  • Returns the custom CmsData object added.

Remarks

This method takes one argument for the ActivityData class. When you add the Activity data, the method returns a new custom ActivityData object.

Set a valid ActvityTypeID based on the activity item or the ObjectID. To get available activity types, use ActivityTypeManager. GetList(ActivityTypeCriteria) or choose Workarea > Settings > Community Management > Notifications > ActivityTypes.

Add .aspx code snippet

<ol class="formFields">                 
  <li class="clearfix">
    <ektronUI:Label ID="uxWebEventIDLabel" AssociatedControlID="uxWebEventID" CssClass="span-4 last"
      runat="server" Text="* WebEventID :" />
    <ektronUI:TextField ID="uxWebEventID" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
      Text="251" />
  </li>
  <li class="clearfix">
    <ektronUI:Label ID="uxMesageLabel" AssociatedControlID="uxActivityMessage" CssClass="span-4 last"
      runat="server" Text="*Activity Mesage :" />
    <ektronUI:TextField ID="uxActivityMessage" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
      Text="A NewCalendarEvent is added" />
  </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>

Add .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.Activity;
using Ektron.Cms.Framework.Activity;
using Ektron.Cms.Common.Calendar;
using Ektron.Cms.Framework.Calendar;Add .aspx.cs

Code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            ActivityManager activityManager = new ActivityManager();
            WebEventManager webeventManager = new WebEventManager();
            long eventid = Convert.ToInt64(uxWebEventID.Text);
            //Check the WebEvent Details
            WebEventData WebeventData = webeventManager.GetItem(eventid);
            if (WebeventData != null)
            {
                ActivityUserInfo userInfo = new ActivityUserInfo();
                userInfo.Id = activityManager.UserId;
                //Set the Activity Details
                ActivityData activityData = new ActivityData()
                {
                    ActivityTypeId = 25,
                    ActionUser = userInfo,
                    Message = uxActivityMessage.Text,
                    ObjectId = eventid,
                    Date = DateTime.Now,
                    LanguageId = 1033
                };
                //Add a New Activity with given activityDetails.
                activityManager.Add(activityData);
                MessageUtilities.UpdateMessage(uxMessage, "Activity Saved with Id " + activityData.Id, Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid WebEvent ID and Try again.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

AddActivityMessage

AddActivityMessage(System.Int64,System.Int32,System.String)

Adds a language-specific message for an activity to the activity stream.

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

  • * Activity ID
  • * Language ID
  • * Activity Message

Parameters

  • activityId. ID of activity to add message for.
  • languageId. ID of language to add message for.
  • message. Activity message to be added.

Code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxActivityIDLabel" AssociatedControlID="uxActivityID" CssClass="span-4 last"
            runat="server" Text="*Activity ID :" />
        <ektronUI:TextField ID="uxActivityID" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxLanguageLabel" AssociatedControlID="uxLanguageId" CssClass="span-4 last"
            runat="server" Text="*Language ID :" />
        <ektronUI:TextField ID="uxLanguageId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="1033" />
    </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="" />
    </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>

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.Activity;
using Ektron.Cms.Framework.Activity;
using Ektron.Cms.Common.Calendar;
using Ektron.Cms.Framework.Calendar;

Code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            ActivityManager activityManager = new ActivityManager();
            long activityID = Convert.ToInt64(uxActivityID.Text);
            //Check the ActivityDetails
            ActivityData activityData = activityManager.GetItem(activityID);
            if (activityData != null)
            {
                //Add a Activity with given activityDetails.
                activityManager.AddActivityMessage(activityID, Convert.ToInt32(uxLanguageId.Text), uxActivityMessage.Text);
                MessageUtilities.UpdateMessage(uxMessage, "Activity Saved with Id " + activityData.Id, Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid Activity 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 an activity from the activity stream.

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

  • * Activity ID

Parameters

  • comment. Activity data to delete.

Remarks

Validate the item using GetItem() before deleting.

.aspx code snippet

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

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            ActivityManager activityManager = new ActivityManager();
            long activityID = Convert.ToInt64(uxActivityID.Text);
            //Check the ActivityDetails
            ActivityData activityData = activityManager.GetItem(activityID);
            if (activityData != null)
            {   //Delete the  Activity ID from the CMS
                activityManager.Delete(activityID);
                MessageUtilities.UpdateMessage(uxMessage, "Activity  with Id " + activityData.Id + " has been Deleted", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid Activity ID and Try again.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

DisableActivityEmailReply

DisableActivityEmailReply(ActivityData)

Disables activity email replies for the site.

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

  • * Disable Activity Email Reply

.aspx code snippet

<ol class="formFields"> 
    <li class="clearfix">
        <ektronUI:Label ID="uxDisableActivityEmailLabel" AssociatedControlID="uxDisableActivityEmail"
            CssClass="span-5 last" runat="server" Text="*Disable Activity Email Reply:" /> 
        <ektronUI:Button ID="uxDisableActivityEmail" CssClass="span-5" 
            runat="server" ValidationGroup="RegisterValidationGroup"
            DisplayMode="Checkbox" Text="" /> 
    </li>
    <li class="clearfix"> 
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click"
            Text="Disable"></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.Site;
using Ektron.Cms; 
using Ektron.Cms.Activity; 
using Ektron.Cms.Framework.Activity;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            ActivityManager activityManager = new ActivityManager();
            if (!activityManager.IsActivityEmailReplyEnabled)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Activity Email Reply is Already Disabled.", Message.DisplayModes.Success);
            }
            else
            {
                if (uxDisableActivityEmail.Checked)
                {   //Disable the Activity Email Reply
                    activityManager.DisableActivityEmailReply();
                    MessageUtilities.UpdateMessage(uxMessage, "Activity Email Reply has been Disabled.", Message.DisplayModes.Success);
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Activity Email Reply is Not Disabled.", Message.DisplayModes.Error);
                }
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

DisableActivityPublishing

DisableActivityPublishing(Ektron.Cms.Activity.ActivityData)

Disables activity publishing for the site.

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

  • * Disable Activity Publishing

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxDisableActivityPublishLabel" AssociatedControlID="uxDisableActivityPublish"
            CssClass="span-4 last" runat="server" Text="*Disable Activity Publish :" />
        <ektronUI:Button ID="uxDisableActivityPublish" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            DisplayMode="Checkbox" Text=""/>
    </li>
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Disable"></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.Activity;
using Ektron.Cms.Framework.Activity;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            ActivityManager activityManager = new ActivityManager();
            if (!activityManager.IsActivityPublishingEnabled)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Activity Publishing is Already Disabled.", Message.DisplayModes.Success);
            }
            else
            {
                if (uxDisableActivityPublish.Checked)
                {   //Disable the Activity Publishing
                    activityManager.DisableActivityPublishing();
                    MessageUtilities.UpdateMessage(uxMessage, "Activity Publishing has been Disabled.", Message.DisplayModes.Success);
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Activity Publishing is Not Disabled.", Message.DisplayModes.Error);
                }
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

EnableActivityEmailReply

EnableActivityEmailReply(Ektron.Cms.Activity.ActivityData)

Enables activity email replies for the site.

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

  • * Enable Activity Email Reply

.aspx code snippet

<ol class="formFields">
        <li class="clearfix">
            <ektronUI:Label ID="uxEnableActivityEmailLabel" AssociatedControlID="uxEnableActivityEmail"
                CssClass="span-4 last" runat="server" Text="*Enable Activity Email Reply :" />
            <ektronUI:Button ID="uxEnableActivityEmail" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
                    DisplayMode="Checkbox" />
        </li>
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Enable"></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.Activity;
using Ektron.Cms.Framework.Activity;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            ActivityManager activityManager = new ActivityManager();
            if (activityManager.IsActivityEmailReplyEnabled)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Activity Email Reply is Already Enabled.", Message.DisplayModes.Success);
            }
            else
            {
                if (uxEnableActivityEmail.Checked)
                {   //Enable the Activity Email Reply
                    activityManager.EnableActivityEmailReply();
                    MessageUtilities.UpdateMessage(uxMessage, "Activity Email Reply has been Enabled.", Message.DisplayModes.Success);
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Activity Email Reply is Not Enabled.", Message.DisplayModes.Error);
                }
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

EnableActivityPublishing

EnableActivityPublishing(Ektron.Cms.Activity.ActivityData)

Enables activity publishing for the site and set up default notification preferences for existing users.

NOTE:  Depending on the number of users, this call could be time-consuming.

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

  • * Enable Activity Publishing

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxEnableActivityPublishLabel" AssociatedControlID="uxEnableActivityPublish"
            CssClass="span-4 last" runat="server" Text="*EnableActivity Publish :" />
        <ektronUI:Button ID="uxEnableActivityPublish" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
                DisplayMode="Checkbox" />
    </li>
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Enable"></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.Activity;
using Ektron.Cms.Framework.Activity;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            ActivityManager activityManager = new ActivityManager();
            if (activityManager.IsActivityPublishingEnabled)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Activity Publishing is Already Enabled.", Message.DisplayModes.Success);
            }
            else
            {
                if (uxEnableActivityPublish.Checked)
                {   //Enable the Activity Publishing
                    activityManager.EnableActivityPublishing();
                    MessageUtilities.UpdateMessage(uxMessage, "Activity Publishing has been Enabled.", Message.DisplayModes.Success);
                }
                else
                {                   
                    MessageUtilities.UpdateMessage(uxMessage,"Activity Publishing is Not Enabled.", Message.DisplayModes.Warning);
                }
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

GetItem

GetItem(System.Int64)

Returns a single ActivityStream Item by 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

  • * Activity ID

Parameters

  • id. ID of activity to retrieve.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxActivityIDLabel" AssociatedControlID="uxActivityID" CssClass="span-4 last"
            runat="server" Text="*Activity ID :" />
        <ektronUI:TextField ID="uxActivityID" CssClass="span-4" 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="uxObjectId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxActionUserID" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxActivityMessage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxActivityTypeID" 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.Activity;
using Ektron.Cms.Framework.Activity;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            ActivityManager activityManager = new ActivityManager();
            long activityID = Convert.ToInt64(uxActivityID.Text);
            //Check the ActivityDetails
            ActivityData activityData = activityManager.GetItem(activityID);
            if (activityData != null)
            {   //Display the Activity Details

                MessageUtilities.UpdateMessage(uxMessage, "Activity Details  for ActivityId " + activityData.Id + " are below", Message.DisplayModes.Success);
                uxObjectId.Text = "Object ID: " + activityData.ObjectId.ToString();
                uxActionUserID.Text = "Action UserID: " + activityData.ActionUser.Id.ToString();
                uxActivityMessage.Text = "Activity Message: " + activityData.Message;
                uxActivityTypeID.Text = "Activity Type ID: " + activityData.ActivityTypeId.ToString();
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid Activity 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(Ektron.Cms.Activity.ActivityCriteria
  Ektron.Cms.Common.EkEnumeration.ActivityFeedType,System.Int64)

Gets an Activity Feed based upon the feedtype and the 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

  • Activity 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="uxActivityPropertyLabel" AssociatedControlID="uxActivityProperty"
            CssClass="span-3 last" runat="server" Text="Feed Type :" />
        <asp:DropDownList ID="uxActivityProperty" runat="server">
            <asp:ListItem>User</asp:ListItem>
            <asp:ListItem>CommunityGroup</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-3 last"
            runat="server" Text="*ID :" />
        <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="uxActivityList" 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>
                        ObjectId
                    </th>
                    <th>
                        ActivityTypeId
                    </th>
                    <th>
                        Message
                    </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("ObjectId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ActivityTypeId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Message")%>
            </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.Activity;
using Ektron.Cms.Framework.Activity;
using Ektron.Cms.Common;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long feedTypeId;
            string Property = uxActivityProperty.SelectedItem.Text;

            ActivityManager activityManager = new ActivityManager();
            ActivityCriteria criteria = new ActivityCriteria();
            List<ActivityData> activityList = new List<ActivityData>();

            feedTypeId = Convert.ToInt64(uxObjectValue.Text);
            if (Property == "User")
            {
                //Get Activity List for given feedTypeId
                activityList = activityManager.GetList(criteria, Ektron.Cms.Common.EkEnumeration.ActivityFeedType.User, feedTypeId);
            }
            else
            {
                //Get Activity List for given feedTypeId
                activityList = activityManager.GetList(criteria, Ektron.Cms.Common.EkEnumeration.ActivityFeedType.CommunityGroup, feedTypeId);
            }

            uxActivityList.Visible = true;
            uxActivityList.DataSource = activityList;
            uxActivityList.DataBind();

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

    }

GetList

GetList(Ektron.Cms.Activity.ActivityCriteria,Ektron.Cms.Common.EkEnumeration.ActivityFeedType,System.Int64)

Gets an Activity Feed based upon the feed type and the 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

  • * Feed Type
  • * ID

Parameters

  • criteria. ActivityCriteria for further filtering the feed, sorting, and paging.
  • feedType. The type of feed to retrieve. For example, User or CommunityGroup.
  • feedTypeId. The ID corresponding to the feed type. For example, if FeedType = User, FeedTypeId would be the user ID to retrieve feed for.

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="uxActivityPropertyLabel" AssociatedControlID="uxActivityProperty" CssClass="span-3 last"
            runat="server" Text="Activity Property :" />
        <asp:DropDownList ID="uxActivityProperty" runat="server">
            <asp:ListItem>ActionUserId</asp:ListItem>
            <asp:ListItem>Id</asp:ListItem>
            <asp:ListItem>ActivityTypeId</asp:ListItem>                         
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-3 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="uxActivityList" 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>
                        ObjectId
                    </th>
                    <th>
                        ActivityTypeId
                    </th>
                    <th>
                        Message
                    </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("ObjectId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ActivityTypeId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Message")%>
            </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.Activity;
using Ektron.Cms.Framework.Activity;
using Ektron.Cms.Common;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            object Objectvalue;
            string Property = uxActivityProperty.SelectedItem.Text;
            ActivityManager activityManager = new ActivityManager();
            ActivityCriteria activityCriteria = new ActivityCriteria();
            Objectvalue = Convert.ToInt64(uxObjectValue.Text);
            if (Property == "Id")
            {
                activityCriteria.AddFilter(ActivityProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (Property == "ActivityTypeId")
            {
                activityCriteria.AddFilter(ActivityProperty.ActivityTypeId, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                activityCriteria.AddFilter(ActivityProperty.ActionUserId, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            //Get Activity List for given Filter
            List<ActivityData> activityList = activityManager.GetList(activityCriteria);

            uxActivityList.Visible = true;
            uxActivityList.DataSource = activityList;
            uxActivityList.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);

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

    }

GetListForUser (1)

GetListForUser(System.Int64,Ektron.Cms.PagingInfo)

Retrieves a list of activities associated with a user that is the subject or the actor.

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

Parameters

  • pagingInfo. Paging information for retrieval.
  • userId. ID of user to retrieve feed for.

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="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-3 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="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="uxActivityList" 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>
                        ObjectId
                    </th>
                    <th>
                        ActivityTypeId
                    </th>
                    <th>
                        Message
                    </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("ObjectId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ActivityTypeId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Message")%>
            </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.Activity;
using Ektron.Cms.Framework.Activity;
using Ektron.Cms.Framework.User;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            ActivityManager activityManager = new ActivityManager();
            UserManager Usermanager = new UserManager();
            long UserId = long.Parse(uxUserId.Text);
            //Check the given UserID valid or Not
            UserData Userdata = Usermanager.GetItem(UserId);
            if (Userdata != null)
            {    //Paging Information
                PagingInfo paging = new PagingInfo();
                paging.CurrentPage = 1;
                paging.RecordsPerPage = 50;
                //Get the Activity List
                List<ActivityData> activityList = activityManager.GetListForUser(UserId, paging);
                //Display the Activity List
                uxActivityList.Visible = true;
                uxActivityList.DataSource = activityList;
                uxActivityList.DataBind();
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid User ID and Try again.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

GetListForUser (2)

GetListForUser(System.Int64,Ektron.Cms.PagingInfo,System.Int32)

Retrieves a list of activities associated with a user that is the subject or the Actor.

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
  • Return Comment Count

Parameters

  • pagingInfo. Paging information for retrieval.
  • userId. ID of user to retrieve feed for.

  • returnCommentCount. Number of comments to return with each activity. 0 = no comments, -1 = all.

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="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-5 last"
            runat="server" Text="*User Id:" />
        <ektronUI:TextField ID="uxUserId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="1" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCommentCountLabel" AssociatedControlID="uxCommentCount" CssClass="span-5 last"
            runat="server" Text="ReturnComment Count:" />
        <asp:DropDownList ID="uxCommentCount" runat="server">
            <asp:ListItem>-1</asp:ListItem>
            <asp:ListItem>0</asp:ListItem>
        </asp:DropDownList>
    </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="uxActivityList" 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>
                        ObjectId
                    </th>
                    <th>
                        ActivityTypeId
                    </th>
                    <th>
                        Message
                    </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("ObjectId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ActivityTypeId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Message")%>
            </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.Activity;
using Ektron.Cms.Framework.Activity;
using Ektron.Cms.Framework.User;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            ActivityManager activityManager = new ActivityManager();
            UserManager Usermanager = new UserManager();
            long UserId = long.Parse(uxUserId.Text);
            //Check the given UserID valid or Not
            UserData Userdata = Usermanager.GetItem(UserId);
            if (Userdata != null)
            {    //Paging Information
                PagingInfo paging = new PagingInfo();
                paging.CurrentPage = 1;
                paging.RecordsPerPage = 50;
                //Return Comment Count value i.e -1 (ALL comments) or 0
                int returnCommentCount = int.Parse(uxCommentCount.SelectedItem.Text);
                //Get the Activity List with Comments
                List<ActivityData> activityList = activityManager.GetListForUser(UserId, paging, returnCommentCount);
                //Display the Activity List
                uxActivityList.Visible = true;
                uxActivityList.DataSource = activityList;
                uxActivityList.DataBind();
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid User ID and Try again.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

Publish

Publish(Ektron.Cms.Activity.ActivityData)

Publishes an activity to all subscribers.

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

  • *Activity ID

Parameters

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxActivityIDLabel" AssociatedControlID="uxActivityID" CssClass="span-4 last"
            runat="server" Text="*Activity ID :" />
        <ektronUI:TextField ID="uxActivityID" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">                
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Publish"></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.Site;
using Ektron.Cms;
using Ektron.Cms.Activity;
using Ektron.Cms.Framework.Activity;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            ActivityManager activityManager = new ActivityManager();
            long activityID = Convert.ToInt64(uxActivityID.Text);
            //Check the ActivityDetails
            ActivityData activityData = activityManager.GetItem(activityID);
            if (activityData != null)
            {
                //Publish Activity with given activityDetails.
                activityManager.Publish(activityData);
                 MessageUtilities.UpdateMessage(uxMessage, "Activity with Id " + activityData.Id + " has been Published.", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage,  "Please Enter Valid Activity ID 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.ActivityData)

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

  • * Activity ID
  • Web Event ID
  • Activity Message

Parameters

  • activity. ActivityData to update.

Remarks

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

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

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxActivityIDLabel" AssociatedControlID="uxActivityID" CssClass="span-4 last"
            runat="server" Text="*Activity ID :" />
        <ektronUI:TextField ID="uxActivityID" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxWebEventIDLabel" AssociatedControlID="uxWebEventID" CssClass="span-4 last"
            runat="server" Text="WebEventID :" />
        <ektronUI:TextField ID="uxWebEventID" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxMesageLabel" AssociatedControlID="uxActivityMessage" CssClass="span-4 last"
            runat="server" Text="Activity Mesage :" />
        <ektronUI:TextField ID="uxActivityMessage" 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.Activity;
using Ektron.Cms.Framework.Activity;
using Ektron.Cms.Common.Calendar;
using Ektron.Cms.Framework.Calendar;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            ActivityManager activityManager = new ActivityManager();
            long activityID = Convert.ToInt64(uxActivityID.Text);
            //Check the ActivityDetails
            ActivityData activityData = activityManager.GetItem(activityID);
            if (activityData != null)
            {
                if (activityData.ActivityTypeId == 25)
                {
                    WebEventManager webeventManager = new WebEventManager();
                    long eventid = Convert.ToInt64(uxWebEventID.Text);
                    if (eventid > 0)
                    {
                        //Check the WebEvent Details
                        WebEventData WebeventData = webeventManager.GetItem(eventid);
                        if (WebeventData != null)
                        {
                            activityData.ObjectId = eventid;
                        }
                    }
                    else
                    {
                        activityData.ObjectId = activityData.ObjectId;
                    }
                    activityData.Message = uxActivityMessage.Text != string.Empty ? uxActivityMessage.Text : activityData.Message;
                    //Update Activity with given activity Details.
                    activityManager.Update(activityData);

                    MessageUtilities.UpdateMessage(uxMessage, "Activity  with Id " + activityData.Id + " has been Updated", Message.DisplayModes.Success);
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Please Enter a WebEvent Activity ID and try again", Message.DisplayModes.Error);
                }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid Activity ID and Try again.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

UpdateActivityMessage

UpdateActivityMessage(System.Int64,System.Int32,System.String)

Updates an existing message for an activity to the activity stream.

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

  • * Activity ID
  • Language ID
  • Activity Message

Parameters

  • activityId. ID of activity to add message for.
  • languageId. ID of language to add message for.
  • message. Activity message to be added.

.aspx code snippet

ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxActivityIDLabel" AssociatedControlID="uxActivityID" CssClass="span-4 last"
            runat="server" Text="*Activity ID :" />
        <ektronUI:TextField ID="uxActivityID" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxLanguageLabel" AssociatedControlID="uxLanguageId" CssClass="span-4 last"
            runat="server" Text="Language ID :" />
        <ektronUI:TextField ID="uxLanguageId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="1033" />
    </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="" />
    </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.Activity;
using Ektron.Cms.Framework.Activity;
using Ektron.Cms.Common.Calendar;
using Ektron.Cms.Framework.Calendar;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            ActivityManager activityManager = new ActivityManager();
            long activityID = Convert.ToInt64(uxActivityID.Text);
            //Check the ActivityDetails
            ActivityData activityData = activityManager.GetItem(activityID);
            if (activityData != null)
            {
                string message = uxActivityMessage.Text != string.Empty ? uxActivityMessage.Text : activityData.Message;
                activityManager.UpdateActivityMessage(activityID, Convert.ToInt32(uxLanguageId.Text), message);
                //Update a Activity with given activityDetails.
                MessageUtilities.UpdateMessage(uxMessage, "Activity Details for Id " + activityData.Id + " Has been Updated", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid Activity 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

ActivityCriteria

Namespace

Ektron.Cms.Activity

Constructors

  • ActivityCriteria()
    public ActivityCriteria()
  • ActivityCriteria(Ektron.Cms.Activity.ActivityProperty, EkEnumeration.OrderByDirection)
    public ActivityCriteria(Ektron.Cms.Activity.ActivityProperty 
  orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the ActivityProperty are:

    • ActionType
    • ActionUserDisplayName
    • ActionUserId
    • ActivityTypeId
    • CanComment
    • CommentCount
    • Date
    • Id
    • LanguageId
    • Message
    • ObjectId
    • ObjectType
    • ScopeObjectId
    • ScopeObectType
    • SiteId
    • UniqueId
  • ReturnCommentCount. Gets or sets the number of comments to return for each activity in the requested activity list. If 0, no comments are returned. If -1, all comments are returned.
    public int ReturnCommentCount { set; get; }

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()