ActivityTypeManager

The ActivityTypeManager class manages activity types that appear in the activity stream.

Namespace

Ektron.Cms.Framework.Activity.ActivityTypeManager

Constructors

  • ActivityTypeManager()
  • ActivityTypeManager(ApiAccessMode)

Properties

  • ActivityTypeService. Activity Type Service
  • ApiMode. Gets or sets the current API access mode. If set to Admin, the API runs with the permissions of an administrator.
  • ApplicationPath. Gets the application path to the Workarea.
  • ContentLanguage. Gets or sets the current content language.
  • InPreviewMode. Gets or sets the preview mode and returns true if the site is in preview mode.
  • IsCommerceEnabled. Checks for a commerce license.
  • RequestInformation. Gets information about the current request.
  • SitePath. Gets the site path.
  • UserId. Gets or sets the ID of the currently logged-in user.

Methods

Add

Add(Ektron.Cms.Activity.ActivityTypeData)

Adds an ActivityType to the activity stream.

This method takes one argument for the ActivityTypeData class. When you add the Activity Comment data, the method returns a new ActivityType.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

  • * Name

Parameters

Returns

Returns the custom CmsData object added.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxNameLabel" AssociatedControlID="uxName" CssClass="span-4 last"
            runat="server" Text="*Name :" />
        <ektronUI:TextField ID="uxName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="" />
    </li>                 
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add"></ektronUI:Button>
    <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</ol>
     
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Site;
using Ektron.Cms;
using Ektron.Cms.Activity;
using Ektron.Cms.Framework.Activity;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            ActivityTypeManager activityTypeManager = new ActivityTypeManager();
            //Set the Activity Type Details
            ActivityTypeData activityTypeData = new ActivityTypeData()
            {
                Name = uxName.Text,
                ObjectType = Ektron.Cms.Common.EkEnumeration.ActivityObjectType.Content,
                ActionType = Ektron.Cms.Common.EkEnumeration.ActivityActionType.Add,
                Scope = Ektron.Cms.Common.EkEnumeration.ActivityScope.User,
                DisplayInPreferences = true,
                IsPublishByDefault = true,
                SupportsComments = true
            };
            //Add a New Activity Type with given activityTypeDetails.
            activityTypeManager.Add(activityTypeData);
           
            MessageUtilities.UpdateMessage(uxMessage, "Activity Type Saved with Id " + activityTypeData.Id, Message.DisplayModes.Success);

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

    }

Delete

Delete(System.Int64)

Deletes an activity type 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 Type ID

Remarks

Validate the item using GetItem() before deleting.

Parameters

  • id. ID of ActivityType to delete.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxActivityTypeIDLabel" AssociatedControlID="uxActivityTypeID"
            CssClass="span-4 last" runat="server" Text="*Activity TypeID :" />
        <ektronUI:TextField ID="uxActivityTypeID" 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
        {
            ActivityTypeManager activityTypeManager = new ActivityTypeManager();
            long activityTypeID = long.Parse(uxActivityTypeID.Text);
            //Check whether Entered activityTypeID valid or Not
            ActivityTypeData activityTypeData = activityTypeManager.GetItem(activityTypeID);
            if (activityTypeData != null)
            {   //Delete  Activity Type ID from the CMS
                activityTypeManager.Delete(activityTypeID);
                MessageUtilities.UpdateMessage(uxMessage,  "Activity Type Id " + activityTypeID + " has been Deleted from the CMS.", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid Activity Type ID", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

GetItem

GetItem(System.Int64)

Retrieves the properties of a specific ActivityType object.

Authenticated users

  • CMS Administrators

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

Fields

*=Required

  • * Activity Type ID

Parameters

  • id. ID of ActivityType to retrieve.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxActivityTypeIDLabel" AssociatedControlID="uxActivityTypeID"
            CssClass="span-4 last" runat="server" Text="*Activity TypeID :" />
        <ektronUI:TextField ID="uxActivityTypeID" 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="uxName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxObjectType" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxSupportsComments" 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
        {
            ActivityTypeManager activityTypeManager = new ActivityTypeManager();
            long activityTypeID = long.Parse(uxActivityTypeID.Text);
            //Check whether Entered activityTypeID valid or Not
            ActivityTypeData activityTypeData = activityTypeManager.GetItem(activityTypeID);
            if (activityTypeData != null)
            {   //Display given activity TypeId Details 
                MessageUtilities.UpdateMessage(uxMessage,  "Activity Type Details for ID " + activityTypeID + " are below", Message.DisplayModes.Success);
                uxName.Text = "Activity Type Name = " + activityTypeData.Name;
                uxObjectType.Text = "Object Type = " + activityTypeData.ObjectType;
                uxSupportsComments.Text = "Supports Comments = " + activityTypeData.SupportsComments;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid Activity Type ID", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

GetList

GetList(Ektron.Cms.Framework.Activity.ActivityTypeCriteria)

Retrieves lists of objects through the GetList(ActivityTypeCriteria) method.

Authenticated users

  • CMS Administrators

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

Fields

*=Required

  • Activity Property
  • * Object Value

Parameters

Returns

List of ActivityTypeData objects.

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>Id</asp:ListItem>
            <asp:ListItem>ObjectType</asp:ListItem>
            <asp:ListItem>Name</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>
    <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>
                        Name
                    </th>
                    <th>
                        Object Type
                    </th>
                    <th>
                        SupportsComments
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("Id")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Name")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ObjectType")%>
            </td>
            <td class="devsite-method">
                <%# Eval("SupportsComments")%>
            </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;
            ActivityTypeManager activityTypeManager = new ActivityTypeManager();
            ActivityTypeCriteria criteria = new ActivityTypeCriteria();
            criteria.OrderByField = ActivityTypeProperty.Id;
            criteria.OrderByDirection = EkEnumeration.OrderByDirection.Ascending;
            if (Property == "Id")
            {
                Objectvalue = Convert.ToInt64(uxObjectValue.Text);
                criteria.AddFilter(ActivityTypeProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (Property == "ObjectType")
            {
                Objectvalue = Convert.ToInt64(uxObjectValue.Text);
                criteria.AddFilter(ActivityTypeProperty.ObjectType, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                criteria.AddFilter(ActivityTypeProperty.Name, CriteriaFilterOperator.Contains, uxObjectValue.Text);
            }
            //Get Activity Type List for given Filter
            List<ActivityTypeData> activityTypeList = activityTypeManager.GetList(criteria);

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

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

    }

Update

Update(Ektron.Cms.ActivityTypeData)

Updates an existing ActivityType 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 Type ID
  • Name
  • Enable Comments

Remarks

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

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

Parameters

Returns

Returns the custom ActivityTypeData object updated.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxActivityTypeIDLabel" AssociatedControlID="uxActivityTypeID"
            CssClass="span-4 last" runat="server" Text="*Activity TypeID :" />
        <ektronUI:TextField ID="uxActivityTypeID" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxNameLabel" AssociatedControlID="uxName" CssClass="span-4 last"
            runat="server" Text="Name :" />
        <ektronUI:TextField ID="uxName" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxSupportsCommentsLabel" AssociatedControlID="uxSupportsComments"
            CssClass="span-5 last" runat="server" Text="Enable Comments:" />
            <asp:DropDownList ID="uxSupportsComments" runat="server">
            <asp:ListItem>True</asp:ListItem>
            <asp:ListItem>False</asp:ListItem>                   
        </asp:DropDownList>
    </li>
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Update"></ektronUI:Button>
    <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</ol>
      
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Site;
using Ektron.Cms;
using Ektron.Cms.Activity;
using Ektron.Cms.Framework.Activity;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            ActivityTypeManager activityTypeManager = new ActivityTypeManager();
            long activityTypeID = long.Parse(uxActivityTypeID.Text);
            //Check whether Entered activityTypeID valid or Not
            ActivityTypeData activityTypeData = activityTypeManager.GetItem(activityTypeID);
            if (activityTypeData != null)
            {
                activityTypeData.Name = uxName.Text != string.Empty ? uxName.Text : activityTypeData.Name;
                if (uxSupportsComments.SelectedValue.ToString() == "True")
                    activityTypeData.SupportsComments = true;
                else activityTypeData.SupportsComments = false;

                //Update Activity Type with given activityTypeDetails.
                activityTypeManager.Update(activityTypeData);
                MessageUtilities.UpdateMessage(uxMessage, "Activity Type with Id " + activityTypeID + " has been Updated with given details.", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage,"Please Enter Valid Activity Type ID", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

Data Classes

ActivityTypeCriteria

Namespace

Ektron.Cms.Activity

Constructors

  • ActivityTypeCriteria()
    public class ActivityTypeCriteria : Ektron.Cms.Common.Criteria<ActivityTypeProperty>
  • ActivityTypeCriteria(Ektron.Cms.Activity.ActivityTypeProperty, EkEnumeration.OrderByDirection)
    public ActivityTypeCriteria(Ektron.Cms.Activity.ActivityTypeProperty orderByField,
  EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the ActivityTypeProperty are:

    • ActivityId
    • DisplayInPreferences
    • Id
    • IsPublishByDefault
    • Name
    • ObjectType
    • Scope
    • SupportsComments

ActivityTypeData

Namespace

Ektron.Cms.Activity

Properties

  • ActionType. Gets or sets the action associated with the activity.
    public EkEnumeration.ActivityActionType ActionType { set; get; }
  • DisplayInPreferences. Gets or sets the preference display flag. If true, users can define notification preferences for the activity.
    public bool DisplayInPreferences { set; get; }
  • IsPublishByDefault
    public bool IsPublishByDefault { set; get; }
  • Name. Gets or sets the name of the ActivityType.
    public string Name { set; get; }
  • ObjectType. Gets or sets the CMS object type associated with activity. This may be null for custom activities.
    public EkEnumeration.ActivityObjectType ObjectType { set; get; }
  • Scope. Gets or sets the scope of the activity. For example, it may originate from a community group.
    public EkEnumeration.ActivityScope Scope { set; get; }
  • SupportsComments. Gets or sets the flag indicating if this ActivityType supports commenting.
    public bool SupportsComments { set; get; }