ActivityStreamManager

The ActivityStreamManager class manages gets post from and sends posts to the activity stream.

Namespace

Ektron.Cms.Framework.Activity.ActivityStreamManager

Constructors

  • ActivityStreamManager()
  • ActivityStreamManager(ApiAccessMode)

Properties

  • 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.
  • 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

GetUserActivityStream (user activity)

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

Retrieves a list of activities in a user's 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

  • * User ID

Parameters

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

.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
        {
            ActivityStreamManager activityStreamManager = new ActivityStreamManager();
            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 = activityStreamManager.GetUserActivityStream(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);
        }

    }

GetUserActivityStream (specific user activity)

GetUserActivityStream(Ektron.Cms.Activity.ActivityCriteria,System.Int64)

Retrieves a list of activities in a user's activity stream based upon supplied criteria.

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

  • * Object Value
  • * User ID

Parameters

  • criteria. Criteira by which to filter the stream. UserId filter is ignored.
  • userId. ID of user to retrieve feed for.

.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>ActivityTypeId</asp:ListItem>
            <asp:ListItem>Id</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="20" />
    </li>
    <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>
    <li class="clearfix" style="color: red;">
        <ektronUI:Label ID="uxStatus" Visible="false" CssClass="span-9 last" runat="server"
            Text="Status:" />
    </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;
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;
            long UserId = long.Parse(uxUserId.Text);

            ActivityStreamManager activityStreamManager = new ActivityStreamManager();
            ActivityCriteria criteria = new ActivityCriteria();
            criteria.OrderByField = ActivityProperty.Id;
            criteria.OrderByDirection = EkEnumeration.OrderByDirection.Ascending;

            UserManager Usermanager = new UserManager();

            //Check the given UserID valid or Not
            UserData Userdata = Usermanager.GetItem(UserId);
            if (Userdata != null)
            {
                Objectvalue = Convert.ToInt64(uxObjectValue.Text);
                if (Property == "Id")
                {
                    criteria.AddFilter(ActivityProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
                }
                else
                {
                    criteria.AddFilter(ActivityProperty.ActivityTypeId, CriteriaFilterOperator.EqualTo, Objectvalue);
                }
                //Get the Activity List
                List<ActivityData> activityList = activityStreamManager.GetUserActivityStream(criteria, UserId);
                //Display the Activity List
                uxActivityList.Visible = true;
                uxActivityList.DataSource = activityList;
                uxActivityList.DataBind();
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid User ID and Try again.", Message.DisplayModes.Error);
                return;
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

SendActivityToAllStreams

SendActivityToAllStreams(System.Int64)

Sends the activity to all user streams based upon the activity and users preferences.

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

  • activityId. ID of activity to send to streams.

.aspx code snippet

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

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long activityID = Convert.ToInt64(uxActivityID.Text);

            ActivityStreamManager activityStreamManager = new ActivityStreamManager();
            ActivityManager activityManager = new ActivityManager();

            //Check the ActivityDetails
            ActivityData activityData = activityManager.GetItem(activityID);
            if (activityData != null)
            {   //Send a given Activity to all user's streams
                activityStreamManager.SendActivityToAllStreams(activityID);
                MessageUtilities.UpdateMessage(uxMessage, "Activity ID " + activityID + " has sent to all user's streams.", 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);
        }

    }

SendActivityToStreams

SendActivityToStreams(System.Int64)

Sends the activity to all applicable streams based upon the activity and users preferences.

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

  • activityId. ID of activity to send to streams.

.aspx code snippet

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

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long activityID = Convert.ToInt64(uxActivityID.Text);

            ActivityStreamManager activityStreamManager = new ActivityStreamManager();
            ActivityManager activityManager = new ActivityManager();

            //Check the ActivityDetails
            ActivityData activityData = activityManager.GetItem(activityID);
            if (activityData != null)
            {   //Send a given Activity to all applicable streams
                activityStreamManager.SendActivityToStreams(activityID);
                MessageUtilities.UpdateMessage(uxMessage, "Activity ID " + activityID + " has sent to all applicable streams.", 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);
        }

    }

SendActivityToUsersStream

SendActivityToUsersStream(System.Int64,System.Int64)

Sends an activity that is in the general activity stream to a user's 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
  • * User ID

Parameters

  • activityId. ID of activity to add to users feed.
  • userId. ID of user.

.aspx code snippet

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

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long UserId = long.Parse(uxUserId.Text);
            long activityID = Convert.ToInt64(uxActivityID.Text);

            ActivityStreamManager activityStreamManager = new ActivityStreamManager();
            ActivityManager activityManager = new ActivityManager();

            //Check the ActivityDetails
            ActivityData activityData = activityManager.GetItem(activityID);
            if (activityData != null)
            {
                UserManager Usermanager = new UserManager();
                //Check the given UserID valid or Not
                UserData Userdata = Usermanager.GetItem(UserId);
                if (Userdata != null)
                {   //Send Activity to a user's Stream
                    activityStreamManager.SendActivityToUsersStream(activityID, UserId);
                    MessageUtilities.UpdateMessage(uxMessage, "Activity ID " + activityID + " has been added to a general feed of user ID " + UserId, 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 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; }