ContentRatingManager

The ContentRatingManager class manages user valuations on content.

Namespace

Ektron.Cms.Framework.Content.ContentRatingManager

Constructors

  • ContentRatingManager()
  • ContentRatingManager(ApiAccessMode)

Properties

  • ApiMode. Gets or sets the current API access mode. If set to Admin, the API runs with the permissions of an administrator.
  • ApplicationPath. Gets the application path to the Workarea.
  • ContentLanguage. Gets or sets the current content language.
  • ContentRatingService. Returns an instance of the business objects Content Rating Service.
  • 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.contentRatingTypeData)

Adds a content rating type.

Authenticated users

  • CMS Administrators
  • Users that have access permission

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

Fields

*=Required

  • * Content ID
  • * User Rating
  • User Comments

Parameters

  • contentRating. The ContentRatingData object.

Returns

The custom ContentRatingData object added.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxContentIDLabel" AssociatedControlID="uxContentID" CssClass="span-3 last" runat="server" Text="Content Id:" />
        <ektronUI:TextField ID="uxContentID" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
        </li>
        <li class="clearfix">
        <ektronUI:Label ID="uxUserRatingLabel" AssociatedControlID="uxUserRating" CssClass="span-3 last" runat="server" Text="User Rating(between 1 and 10 and no decimal values):" />
        <ektronUI:TextField ID="uxUserRating" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
        </li>
        <li class="clearfix">
        <ektronUI:Label ID="uxUserCommentsLabel" AssociatedControlID="uxUserComments" CssClass="span-3 last" runat="server" Text="User Comments:" />
        <ektronUI:TextField ID="uxUserComments" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
        </li>
        <li class="clearfix">
        <ektronUI:Label ID="uxContentRatingStatus" Visible="false" CssClass="span-3 last" runat="server" Text="Status:" />
        </li>
        <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
        </li>
</ol>
<ol class="formFields">
        <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
        </li>
        <li class="clearfix">
        <asp:Literal ID="uxContentLanguage" runat="server"></asp:Literal>
        </li>
        <li class="clearfix">
        <asp:Literal ID="uxUserID" runat="server"></asp:Literal>
        </li>
        <li class="clearfix">
        <asp:Literal ID="uxLilUserRating" runat="server"></asp:Literal>
        </li>
        <li class="clearfix">
        <asp:Literal ID="uxRatingDate" runat="server"></asp:Literal>
        </li>
        <li class="clearfix">
        <asp:Literal ID="uxUserComment" runat="server"></asp:Literal>
    </li>
</ol>

.aspx.cs code-behind namespace

using System;
using System.Collections;
using System.Collections.Generic;
using System.Data;
using System.Diagnostics;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Framework.Content;
using Ektron.Cms.Framework.User;
using Ektron.Cms;
using Microsoft.VisualBasic;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
            try
            {
                ContentRatingManager contentRatingManager = new ContentRatingManager();
                ContentRatingData cRatingData = new ContentRatingData();
                long contentID = long.Parse(uxContentID.Text);
                bool cIDResult = Information.IsNumeric(uxContentID.Text);
                int contentRating = int.Parse(uxUserRating.Text);
                bool cRatingResult = Information.IsNumeric(uxContentID.Text);
                if (!(cRatingResult))
                {
                    MessageUtilities.UpdateMessage(uxMessage, " Rating Should be between 0 and 10", Message.DisplayModes.Error);   
                    return;
                }
                string userComments = uxUserComments.Text;
                UserAPI userApi = new UserAPI();
                long UserId = userApi.RequestInformationRef.UserId;
                ContentManager contentManager = new ContentManager();
                ContentData cData = new ContentData();
                cData = contentManager.GetItem(contentID, false);
                if (!(cIDResult) && (cData == null))
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Content Id is not valid", Message.DisplayModes.Error);   
                    return;
                }
                cRatingData.ContentId = contentID;
                cRatingData.ContentLanguageId = cData.LanguageId;
                cRatingData.UserComments = userComments;
                cRatingData.UserId = UserId;
                cRatingData.UserRating = contentRating;
                cRatingData.RatingDate = DateTime.Now;
                cRatingData.VisitorId = userApi.RequestInformationRef.ClientEktGUID;
                contentRatingManager.Add(cRatingData);

                MessageUtilities.UpdateMessage(uxMessage, "Content ID : " + cRatingData.ContentId, Message.DisplayModes.Success);
   
                uxContentLanguage.Text = "ContentLanguage Id : " + cRatingData.ContentLanguageId;
                if (UserId > 0) { uxUserID.Text = "Content Reviewed UserId : " + cRatingData.UserId; }
                uxLilUserRating.Text = "User Rating : " + cRatingData.UserRating;
                uxRatingDate.Text = "RatingDate : " + cRatingData.RatingDate;
                uxUserComment.Text = "UserComments : " + cRatingData.UserComments;
                uxPageMultiView.SetActiveView(uxViewMessage); 
            }
            catch (Exception ex)
            {
                MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
                uxPageMultiView.SetActiveView(uxViewMessage);
            }
            
        }

Delete

Delete(System.Int64)

Deletes a content rating type from 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

  • * Content Rating ID

Parameters

  • contentRatingId. The ID of the content rating type to be deleted.

Remarks

Validate the item using GetItem() before deleting.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxContentRatingIdLabel" AssociatedControlID="uxContentRatingId" CssClass="span-3 last" runat="server" Text="* ContentRating Id:" />
        <ektronUI:TextField ID="uxContentRatingId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxContentRatingStatus" Visible="false" CssClass="span-3 last" runat="server" Text="Status:" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Delete"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
    </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.Cms.Framework.Content;
using Microsoft.VisualBasic;
using Ektron.Cms;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
   {
    try
     {
        ContentRatingManager contentRatingManager = new ContentRatingManager();
        ContentRatingData cRatingData = new ContentRatingData();
        long contentRatingID = long.Parse(uxContentRatingId.Text);
        bool result = Information.IsNumeric(uxContentRatingId.Text);
        cRatingData = contentRatingManager.GetItem(contentRatingID);
        if (!((result) && cRatingData != null))
        {
            uxStatus.Visible = true;
            MessageUtilities.UpdateMessage(uxStatus,"Invalid content Rating ID ", Message.DisplayModes.Error);   
            return;
        }

        contentRatingManager.Delete(contentRatingID);

        MessageUtilities.UpdateMessage(uxMessage, "The following content rating ID successfully deleted  : " + contentRatingID, Message.DisplayModes.Success);
   
        uxPageMultiView.SetActiveView(uxViewMessage);
     }
     catch (Exception ex)
     {
         MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
         uxPageMultiView.SetActiveView(uxViewMessage);
     }
            
   }

GetItem

GetItem(Ektron.Cms.ContentData)

Retrieves the properties of a specific content rating object.

Authenticated users

  • CMS Administrators
  • Users that have access permission

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

Fields

*=Required

  • * Content Rating ID

Parameters

  • contentRatingId. The ID of the content rating type to get.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxContentRatingIdLabel" AssociatedControlID="uxContentRatingId" CssClass="span-3 last" runat="server" Text="* ContentRating Id:" />
        <ektronUI:TextField ID="uxContentRatingId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxContentRatingStatus" Visible="false" CssClass="span-3 last" runat="server" Text="Status:" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetDetails"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
    </li>
 </ol>
 <ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxContentID" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxContentLanguage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxContentReviewState" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxUserID" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxUserRating" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxRatingDate" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxUserComment" 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.Cms.Framework.Content;
using Microsoft.VisualBasic;
using Ektron.Cms;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        
            try
            {
                ContentRatingManager contentRatingManager = new ContentRatingManager();
                ContentRatingData cRatingData = new ContentRatingData();
                long contentRatingID = long.Parse(uxContentRatingId.Text);
                bool result = Information.IsNumeric(uxContentRatingId.Text);
                cRatingData = contentRatingManager.GetItem(contentRatingID);
                if (!((result) && cRatingData != null))
                {
                    uxStatus.Visible = true;
                    MessageUtilities.UpdateMessage(uxStatus, "Invalid content Rating ID ", Message.DisplayModes.Error);
                    return;
                }

                MessageUtilities.UpdateMessage(uxMessage, "Content rating details for  content rating Id : " + contentRatingID + " are below", Message.DisplayModes.Success);
                uxContentID.Text = "Content ID : " + cRatingData.ContentId ;
                uxContentLanguage.Text = "ContentLanguage Id : " + cRatingData.ContentLanguageId ;
                uxContentReviewState.Text= "ContentReviewState : " + cRatingData.ContentReviewState ;
                uxUserID.Text = "Content Reviewed UserId : " + cRatingData.UserId ;
                uxUserRating.Text = "User Rating : " + cRatingData.UserRating ;
                uxRatingDate.Text = "RatingDate : " + cRatingData.RatingDate ;
                uxUserComment.Text = "UserComments : " + cRatingData.UserComments;
                uxPageMultiView.SetActiveView(uxViewMessage);
            }
            catch (Exception ex)
            {
                MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
                uxPageMultiView.SetActiveView(uxViewMessage);
            }
                  

    }

GetList

GetList(Ektron.Cms.Content.ContentRatingCriteria)

Retrieves lists of objects.

Authenticated users

  • CMS Administrators
  • Users that have access permission

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

Fields

*=Required

  • * Content Rating 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="uxContentRatingPropertyLabel" AssociatedControlID="uxContentRatingProperty" CssClass="span-6 last" runat="server" Text="* ContentRatingProperty:" />
        <asp:DropDownList ID="uxContentRatingProperty" runat="server">
            <asp:ListItem>UserId</asp:ListItem>
            <asp:ListItem>ContentLanguageId</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-6 last" runat="server" Text="* ObjectValue:" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get List"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-6" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
            
<asp:ListView ID="uxContentRatingDataListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Content Id
                    </th>
                        <th>
                        User Rating
                    </th>
                    <th>
                        User Comments
                    </th>
                    <th>
                        Rating Date
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("ContentId")%>
            </td>
                <td class="devsite-method">
                <%# Eval("UserRating")%>
            </td>
            <td class="devsite-method">
                <%# Eval("UserComments")%>
            </td>
            <td class="devsite-method">
                <%# Eval("RatingDate")%>
            </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.Cms;
using Ektron.Cms.Common;
using Ektron.Cms.Content;
using Ektron.Cms.Framework.Content;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            object Objectvalue;

            ContentRatingCriteria contentRatingCriteria = new ContentRatingCriteria(ContentRatingProperty.Id, EkEnumeration.OrderByDirection.Descending);
            if (uxContentRatingProperty.SelectedItem.Text == "UserId")
            {
                Objectvalue = long.Parse(uxObjectValue.Text);
                contentRatingCriteria.AddFilter(ContentRatingProperty.UserId, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = int.Parse(uxObjectValue.Text);
                contentRatingCriteria.AddFilter(ContentRatingProperty.ContentLanguageId, CriteriaFilterOperator.EqualTo, Objectvalue);
            }

            ContentRatingManager contentRatingManager = new ContentRatingManager();
            List<ContentRatingData> contentRatingDataList = contentRatingManager.GetList(contentRatingCriteria);

            uxContentRatingDataListView.Visible = true;
            uxContentRatingDataListView.DataSource = contentRatingDataList;
            uxContentRatingDataListView.DataBind();

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

Purge

Purge(System.Int64,System.DateTime,System.DateTime)

Purges all ratings of a particular content block over a defined date/time range.

Authenticated users

  • CMS Administrators
  • Users that have access permission

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

Fields

*=Required

  • * Content ID
  • * Start Date Time
  • * End Date Time

Parameters

  • contentId. The ID of the content that is having its ratings purged.
  • startDate. The beginning of the date range of content to be purged.
  • endDate. The end of the date range of content to be purged.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxContentIdLabel" AssociatedControlID="uxContentId" CssClass="span-3 last" runat="server" Text="* Content Id:" />
        <ektronUI:TextField ID="uxContentId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxStartDateLabel" AssociatedControlID="uxStartDate" CssClass="span-3 last" runat="server" Text="*Start DateTime :" />
        <ektronUI:DatePicker Rows="3" ID="uxStartDate" CssClass="span-6" runat="server" Text="MM/DD/YYYY" ValidationGroup="RegisterValidationGroup" />
        <asp:DropDownList ID="uxStartTime" runat="server">
            <asp:ListItem>12</asp:ListItem>
            <asp:ListItem>1</asp:ListItem>
            <asp:ListItem>2</asp:ListItem>
            <asp:ListItem>3</asp:ListItem>
            <asp:ListItem>4</asp:ListItem>
            <asp:ListItem>5</asp:ListItem>
            <asp:ListItem>6</asp:ListItem>
            <asp:ListItem>7</asp:ListItem>
            <asp:ListItem>8</asp:ListItem>
            <asp:ListItem>9</asp:ListItem>
            <asp:ListItem>10</asp:ListItem>
            <asp:ListItem>11</asp:ListItem>
        </asp:DropDownList>
        <asp:DropDownList ID="uxStartPeriod" runat="server">
            <asp:ListItem>AM</asp:ListItem>
            <asp:ListItem>PM</asp:ListItem>
        </asp:DropDownList>
        </li>
        <li class="clearfix">
        <ektronUI:Label ID="uxEndDateLabel" AssociatedControlID="uxEndDate" CssClass="span-3 last" runat="server" Text="*End DateTime :" />
        <ektronUI:DatePicker Rows="3" ID="uxEndDate" CssClass="span-6" runat="server" Text="MM/DD/YYYY" ValidationGroup="RegisterValidationGroup" />
        <asp:DropDownList ID="uxEndTime" runat="server">
            <asp:ListItem>1</asp:ListItem>
            <asp:ListItem>2</asp:ListItem>
            <asp:ListItem>3</asp:ListItem>
            <asp:ListItem>4</asp:ListItem>
            <asp:ListItem>5</asp:ListItem>
            <asp:ListItem>6</asp:ListItem>
            <asp:ListItem>7</asp:ListItem>
            <asp:ListItem>8</asp:ListItem>
            <asp:ListItem>9</asp:ListItem>
            <asp:ListItem>10</asp:ListItem>
            <asp:ListItem>11</asp:ListItem>
            <asp:ListItem>12</asp:ListItem>
        </asp:DropDownList>
        <asp:DropDownList ID="uxEndPeriod" runat="server">
            <asp:ListItem>AM</asp:ListItem>
            <asp:ListItem>PM</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Purge"></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.Cms.Framework.Content;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            String st = uxStartDate.Text + " " + uxStartTime.SelectedItem.Text + ":00:00 " + uxStartPeriod.SelectedItem.Text;
            String et = uxEndDate.Text + " " + uxEndTime.SelectedItem.Text + ":00:00 " + uxEndPeriod.SelectedItem.Text;
            DateTime startDateTime = DateTime.Parse(st);
            DateTime endDateTime = DateTime.Parse(et);

            ContentRatingManager contentRatingManager = new ContentRatingManager();
            contentRatingManager.Purge(long.Parse(uxContentId.Text) , startDateTime, endDateTime);

            MessageUtilities.UpdateMessage(uxMessage, "The content rating successfully purged.", Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

Update

Update(Ektron.Cms.ContentRatingData)

Updates an existing content rating item in the CMS.

Authenticated users

  • CMS Administrators
  • Users that have access permission

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

Fields

*=Required

  • * Content Rating ID
  • * User Rating
  • User Comments

Parameters

  • contentRating. The ContentRatingtData object.

Returns

The custom ContentRatingData object updated.

Remarks

Validate the content rating item with GetItem() before you update the properties. Then, call Update with your modified ContentRatingData object.

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

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxContentRatingIdLabel" AssociatedControlID="uxContentRatingId" CssClass="span-3 last" runat="server" Text="* ContentRating Id:" />
        <ektronUI:TextField ID="uxContentRatingId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
    </li>
    <li class="clearfix">
        <asp:Label ID="Label1" Visible="false" CssClass="span-3 last" runat="server" Text="Status:" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxUserRatingLabel" AssociatedControlID="uxUserRating" CssClass="span-3 last" runat="server" Text="* User Rating(between 1 and 10 and no decimal values):" />
        <ektronUI:TextField ID="uxUserRating" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="9" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxUserCommentsLabel" AssociatedControlID="uxUserComments" CssClass="span-3 last" runat="server" Text="User Comments:" />
        <ektronUI:TextField ID="uxUserComments" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxContentRatingStatus" Visible="false" CssClass="span-3 last" runat="server" Text="Status:" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="Button1" runat="server" OnClick="uxSubmit_Click" Text="Update"></ektronUI:Button>
        <ektronUI:Label ID="Label2" CssClass="span-4" runat="server" Text="* - Required" />
    </li>
 </ol>
 <ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxContentID" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxContentLanguage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxUserID" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxLilUserRating" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxRatingDate" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxUserComment" runat="server"></asp:Literal>
    </li>
 </ol>

.aspx.cs code-behind namespace

using System;
using System.Collections;
using System.Collections.Generic;
using System.Data;
using System.Diagnostics;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms.Framework.Content;
using Ektron.Cms.Framework.User;
using Ektron.Cms;
using Microsoft.VisualBasic;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            ContentRatingManager contentRatingManager = new ContentRatingManager();
            ContentRatingData cRatingData = new ContentRatingData();
            long contentRatingID = long.Parse(uxContentRatingId.Text);
            bool result = Information.IsNumeric(uxContentRatingId.Text);
            cRatingData = contentRatingManager.GetItem(contentRatingID);
            if (!((result) && cRatingData != null))
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Invalid content Rating ID ", Message.DisplayModes.Error);
                return;
            }
            int contentRating = int.Parse(uxUserRating.Text);
            bool cRatingResult = Information.IsNumeric(contentRating);
            if (!(cRatingResult))
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, " Rating Should be between 0 and 10", Message.DisplayModes.Error);
                return;
            }
            string userComments = uxUserComments.Text;
            UserAPI userApi = new UserAPI();
            long UserId = userApi.RequestInformationRef.UserId;
            cRatingData.Id = contentRatingID;           
            cRatingData.UserComments = userComments;
            cRatingData.UserId = UserId;
            cRatingData.RatingDate = DateTime.Now;
            cRatingData.UserRating = contentRating;
            cRatingData.VisitorId = userApi.RequestInformationRef.ClientEktGUID;
            contentRatingManager.Update(cRatingData);

            MessageUtilities.UpdateMessage(uxMessage, "Content Rating ID : " + contentRatingID, Message.DisplayModes.Success);
            uxContentID.Text = "Content ID : "  + cRatingData.ContentId;
            uxContentLanguage.Text = "ContentLanguage Id : " + cRatingData.ContentLanguageId;
            if (UserId > 0) { uxUserID.Text = "Content Reviewed UserId : " + cRatingData.UserId; }
            uxLilUserRating.Text = "User Rating : " + cRatingData.UserRating;
            uxRatingDate.Text = "RatingDate : " + cRatingData.RatingDate;
            uxUserComment.Text = "UserComments : " + cRatingData.UserComments;
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Data Classes

ContentRatingCriteria

Namespace

Ektron.Cms.Content

Properties

  • ContentRatingCriteria()
    public ContentRatingCriteria()
  • ContentRatingCriteria(Ektron.Cms.Common.ContentRatingProperty, EkEnumeration.OrderByDirection)
    public ContentRatingCriteria(Ektron.Cms.Common.ContentRatingProperty
  orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the ContentRatingProperty are:

    • ContentId
    • ContentLanguageId
    • ContentReviewState
    • Id
    • RatingDate
    • RatingState
    • UserId
    • VistorId

ContentRatingData

Namespace

Ektron.Cms

Properties

  • ContentId
    public long ContentId { set; get; }
  • ContentLanguageId
    public int ContentLanguageId { set; get; }
  • ContentReviewState
    public Ektron.Cms.Common.EkEnumeration.ContentReviewState
  ContentReviewState { set; get; }
  • RatingDate
    public System.DateTime RatingDate { set; get; }
  • UserComments
    public string UserComments { set; get; }
  • UserId
    public long UserId { set; get; }
  • UserRating
    public int UserRating { set; get; }
  • VisitorId
    public string VisitorId { set; get; }