ActivityCommentManager

Add

Add(Ektron.Cms.Activity.ActivityCommentData)

Adds activity comment data to the activity stream.

This method takes one argument for the ActivityCommentData data class. When you add the ActivityCommentData, the method returns a new custom ActivityCommentData 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 ID
• * Activity Comment

Parameters

• comment. Activity comment to add.

Returns

• Returns the custom CmsData object added.

Add .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="uxActivityCommentLabel" AssociatedControlID="uxActivityComment"
    CssClass="span-4 last" runat="server" Text="*Activity Comment :" />
  <ektronUI:TextField ID="uxActivityComment" 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>

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;

Add .aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
{
  try
  {
    ActivityCommentManager activityCommentManager = new ActivityCommentManager();
    //Check whether user logged in or not
    if (activityCommentManager.UserId > 0)
    {
      ActivityManager activityManager = new ActivityManager();
      long activityID = Convert.ToInt64(uxActivityID.Text);
      //Check the ActivityDetails
      ActivityData activityData = activityManager.GetItem(activityID);

      if (activityData != null)
      {
        //Set the Activity Comment Details
        ActivityCommentData activityCommentData = new ActivityCommentData()
        {
          ActivityId = activityID,
          Comment = uxActivityComment.Text,
          DateCreated = DateTime.Now,
          UserId = activityCommentManager.UserId,
        };
        //Add a New Activity Comment with given activityDetails.
        activityCommentManager.Add(activityCommentData);
        MessageUtilities.UpdateMessage(uxMessage, "Activity Comment Saved with Id " + activityCommentData.Id, Message.DisplayModes.Success);
      }
      else
      {
        MessageUtilities.UpdateMessage(uxMessage,"Please Enter Valid Activity ID and Try again.", Message.DisplayModes.Error);
      }
    }
    else
    {  MessageUtilities.UpdateMessage(uxMessage, "Please Login 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 comment 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 Comment ID

Parameters

• id. The ID of activity comment to delete.

Remarks

Validate the item using GetItem() before deleting.

Delete .aspx code snippet

<ol class="formFields">
  <li class="clearfix">
    <ektronUI:Label ID="uxActivityCommentIDLabel" AssociatedControlID="uxActivityCommentID" CssClass="span-4 last"
      runat="server" Text="*ActivityComment ID :" />
    <ektronUI:TextField ID="uxActivityCommentID" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
      Text="1" />
  </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>    

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;   

Add .aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
{
  try
  {
    ActivityCommentManager activityCommentManager = new ActivityCommentManager();
    //Check whether user logged in or not
    if (activityCommentManager.UserId > 0)
    {
      long activityCommentID = long.Parse(uxActivityCommentID.Text);
      //Check, Entered  activityCommentID valid or Not
      ActivityCommentData activityCommentData = activityCommentManager.GetItem(activityCommentID);
      //Check the Activity Comment Data
      if (activityCommentData != null)
      {   //Delete Activity Comment ID from CMS
        activityCommentManager.Delete(activityCommentID);
        MessageUtilities.UpdateMessage(uxMessage, "Activity Comment ID " + activityCommentID + " has been Deleted.", Message.DisplayModes.Success);
      }
      else { MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid Activity Comment ID.", Message.DisplayModes.Error); }
    }
    else
    { MessageUtilities.UpdateMessage(uxMessage, "Please Login and try again.", 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 ActivityCommentData 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

• * ID

Parameters

• id. The ID of activity comment to retrieve.

GetItem .asxp code snippet

<ol class="formFields">
  <li class="clearfix">
    <ektronUI:Label ID="uxActivityCommentIDLabel" AssociatedControlID="uxActivityCommentID"
      CssClass="span-4 last" runat="server" Text="*ActivityComment ID :" />
    <ektronUI:TextField ID="uxActivityCommentID" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
      Text="1" />
  </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="uxActivityID" runat="server"></asp:Literal>
  </li>
  <li class="clearfix">
    <asp:Literal ID="uxComment" runat="server"></asp:Literal>
  </li>
  <li class="clearfix">
    <asp:Literal ID="uxUserID" runat="server"></asp:Literal>
  </li>
  <li class="clearfix">
    <asp:Literal ID="uxDateCreated" runat="server"></asp:Literal>
  </li>
</ol>

GetItem .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;   

GetItem .aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
{
  try
  {
    ActivityCommentManager activityCommentManager = new ActivityCommentManager();
    long activityCommentID = long.Parse(uxActivityCommentID.Text);
    //Check, Entered  activityCommentID valid or Not
    ActivityCommentData activityCommentData = activityCommentManager.GetItem(activityCommentID);
    //Check the Activity Comment Data
    if (activityCommentData != null)
    {   //Display the Activity Comment Details.
      MessageUtilities.UpdateMessage(uxMessage,"Activity Comment Details for ID " + activityCommentID + " are below", Message.DisplayModes.Success);
      uxActivityID.Text = "Activity ID = " + activityCommentData.ActivityId;
      uxComment.Text = "Activity Comment = " + activityCommentData.Comment;
      uxUserID.Text = "User ID = " + activityCommentData.UserId;
      uxDateCreated.Text = "DateCreated = " + activityCommentData.DateCreated;
    }
    else { MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid Activity Comment 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.Activity.ActivityCommentCriteria)

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

• criteria. Criteria used to filter results.

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.

GetList.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>UserId</asp:ListItem>
      <asp:ListItem>Id</asp:ListItem>
      <asp:ListItem>Comment</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>Comment Id</th>
          <th>Activity Id</th>
          <th>User Id</th>
          <th>Comment</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("ActivityId")%></td>
      <td class="devsite-method"><%# Eval("UserId")%></td>
      <td class="devsite-method"><%# Eval("Comment")%></td>
    </tr>
  </ItemTemplate>
</asp:ListView>

GetList .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;

GetList .aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
{
  try
  {
    object Objectvalue;
    string Property = uxActivityProperty.SelectedItem.Text;
    ActivityCommentManager activityCommentManager = new ActivityCommentManager();
    ActivityCommentCriteria criteria = new ActivityCommentCriteria();
    criteria.OrderByField = ActivityCommentProperty.Id;
    criteria.OrderByDirection = EkEnumeration.OrderByDirection.Ascending;

    if (Property == "Id")
    {
      Objectvalue = Convert.ToInt64(uxObjectValue.Text);
      criteria.AddFilter(ActivityCommentProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
    }
    else if (Property == "UserId")
    {
      Objectvalue = Convert.ToInt64(uxObjectValue.Text);
      criteria.AddFilter(ActivityCommentProperty.UserId, CriteriaFilterOperator.EqualTo, Objectvalue);
    }
    else
    {
      criteria.AddFilter(ActivityCommentProperty.Comment, CriteriaFilterOperator.Contains, uxObjectValue.Text);
    }
    //Get Activity Comment List for given Filter
    List<ActivityCommentData> activityCommentList = activityCommentManager.GetList(criteria);

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

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

Update

Update(Ektron.Cms.ActivityCommentData)

Updates an existing ActivityCommentData item in the CMS.

This method takes one argument for the ActivityCommentData data class. When you use the ActivityCommentData, the method returns an updated custom ActivityCommentData 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 Comment ID
• Activity ID
• Activity Comment

Parameters

• comment. Activity comment to update.

Returns

Returns the custom CmsData object updated.

Remarks

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

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

Update .aspx code snippet

<ol class="formFields">
  <li class="clearfix">
    <ektronUI:Label ID="uxActivityCommentIDLabel" AssociatedControlID="uxActivityCommentID" CssClass="span-4 last"
      runat="server" Text="*ActivityComment ID :" />
    <ektronUI:TextField ID="uxActivityCommentID" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
      Text="1" />
  </li>
  <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="uxActivityCommentLabel" AssociatedControlID="uxActivityComment"
      CssClass="span-4 last" runat="server" Text="Activity Comment :" />
    <ektronUI:TextField ID="uxActivityComment" 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>

Update .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;

Update .aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
{
  try
  {
    //Check whether user logged in or not
    if (activityCommentManager.UserId > 0)
    {
      activityCommentID = long.Parse(uxActivityCommentID.Text);
      //Check, Entered  activityCommentID valid or Not
      activityCommentData = activityCommentManager.GetItem(activityCommentID);
      //Check the Activity Comment Data
      if (activityCommentData != null)
      {
        ActivityManager activityManager = new ActivityManager();
        long activityID = Convert.ToInt64(uxActivityID.Text);
        if (activityID > 0)
       {
         //Check the ActivityDetails
         ActivityData activityData = activityManager.GetItem(activityID);
         if (activityData != null)
         {
           //Update the Activity Comment Details                       
           activityCommentData.ActivityId = activityID;
           update();
         }
         else
         {
           MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid Activity ID and Try again.", Message.DisplayModes.Error);
         }
        }
        else
        {     
          update();
        }

      }
        else { MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid Activity Comment ID.", Message.DisplayModes.Error); }
    }
    else
    {  MessageUtilities.UpdateMessage(uxMessage, "Please Login and try again.", Message.DisplayModes.Error); }
    uxPageMultiView.SetActiveView(uxViewMessage);
  }
  catch (Exception ex)
  {
    MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
    uxPageMultiView.SetActiveView(uxViewMessage);
  }
}        

ActivityCommentCriteria

Namespace

Ektron.Cms.Activity

Constructors

• ActivityCommentCriteria()

  public ActivityCommentCriteria()

• ActivityCommentCriteria(Ektron.Cms.Activity.ActivityCommentProperty, EkEnumeration.OrderByDirection)

  public ActivityCommentCriteria(Ektron.Cms.Activity.ActivityCommentProperty orderByField, 
    EkEnumeration.OrderByDirection orderByDirection)

  Accepted fields for the ActivityCommentProperty are:

  • ActivityId
  • CanDelete
  • Comment
  • DateCreated
  • Id
  • UserAvatar
  • UserDisplayName
  • UserId

Properties

• ReturnCommentCount. Gets or sets the number of comments to return for each activity in the requested activity list. If 0, no comments will be returned. If -1, All Comments will be returned.

  public int ReturnCommentCount { set; get; }

ActivityCommentData

Namespace

Ektron.Cms.Activity

Properties

• ActivityId. Gets or sets the Id of the Activity the comment belongs to.

  public long ActivityId { set; get; }

• CanDelete. Gets or sets the Can delete permissions for the comment.

  public bool CanDelete { set; get; }

• Comment. Gets or sets the comment text.

  public string Comment { set; get; }

• DateCreated. Gets or sets the date the comment was created.

  public System.DateTime DateCreated { set; get; }

• Id. Gets or sets the Id of the comment.

  public long Id { set; get; }

• TimeLapse. Gets or sets the time lapse for the comment.

  public string TimeLapse { set; get; } 

• UserAvatar. Gets or sets the avatar of the user who made the comment.

  public string UserAvatar { set; get; }

• UserDisplayName. Gets or sets the display name of the user who made the comment.

  public string UserDisplayName { set; get; }

• UserId. Gets or sets the ID of the user who made the comment.

  Gets or sets the display name of the user who made the comment.