FavoriteManager

The FavoriteManager class manages a list of Ektron CMS content and external Web links (URLs) that a user has designated as favorite content.

Namespace

Ektron.Cms.Framework.Community.FavoriteManager

Constructors

  • FavoriteManager()
  • FavoriteManager(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.
  • FavoriteManagerService. Returns an instance of the business objects favorite manager 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.Community.FavoriteItemData)

Adds a favorite item, with details from the supplied FavoriteItemData 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

  • * Title
  • * Object Type
  • * Object Value
  • * User ID
  • Description

Parameters

  • favoriteItemData. The FavoriteItemData object to add.

Returns

A custom FavoriteItemData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxTitlelabel" AssociatedControlID="uxTitle" CssClass="span-4 last" runat="server" Text="* Title:" />
        <ektronUI:TextField ID="uxTitle" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"  />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxFavoriteItemObjectTypeLabel" AssociatedControlID="uxFavoriteItemObjectType" CssClass="span-4 last" runat="server" Text="* Object Type:" />
        <asp:DropDownList ID="uxFavoriteItemObjectType" runat="server">
            <asp:ListItem>Content</asp:ListItem>
            <asp:ListItem>Url</asp:ListItem>
        </asp:DropDownList>
    </li>
        <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-4 last" runat="server" Text="* Object Value:" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"  />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-4 last" runat="server" Text="* User Id:" />
        <ektronUI:TextField ID="uxUserId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxDescriptionLabel" AssociatedControlID="uxDescription" CssClass="span-4 last" runat="server" Text=" Description:" />
        <asp:TextBox TextMode="MultiLine" Rows="3"  ID="uxDescription" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </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>
 
<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.Community;
using Ektron.Cms.Common;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            Ektron.Cms.Framework.Community.FavoriteManager favoriteManager = new Ektron.Cms.Framework.Community.FavoriteManager();
            FavoriteItemData favoriteItemData = new FavoriteItemData()
            {
                Title = uxTitle.Text,
                ObjectType = (uxFavoriteItemObjectType.SelectedItem.Text == "Content" ? Ektron.Cms.Common.FavoriteType.Content : Ektron.Cms.Common.FavoriteType.Url),
                ObjectId = (uxFavoriteItemObjectType.SelectedItem.Text == "Content" ? long.Parse(uxObjectValue.Text) : 0),
                Url = uxObjectValue.Text,
                Description = uxDescription.Text,
                // TaxonomyId= 334,
                UserId = long.Parse(uxUserId.Text)
            };

            if (uxFavoriteItemObjectType.SelectedItem.Text != "Content")
            {
                FavoriteItemCriteria criteria = new Ektron.Cms.Community.FavoriteItemCriteria(FavoriteItemProperty.id, EkEnumeration.OrderByDirection.Ascending);
                criteria.AddFilter(FavoriteItemProperty.Title, CriteriaFilterOperator.EqualTo, uxTitle.Text);
                criteria.AddFilter(FavoriteItemProperty.Url, CriteriaFilterOperator.EqualTo, uxObjectValue.Text);
                List<FavoriteItemData> uxFavoriteItemList = favoriteManager.GetList(criteria);
                if (uxFavoriteItemList.Count == 0)
                    favoriteManager.Add(favoriteItemData);
                else
                    MessageUtilities.UpdateMessage(uxMessage, "Favorite Name and Favorite Uri already exists", Message.DisplayModes.Success);
            }
            else
                favoriteManager.Add(favoriteItemData);

            if (string.IsNullOrEmpty(uxMessage.Text))
            {
                if (uxFavoriteItemObjectType.SelectedItem.Text == "Content")
                    MessageUtilities.UpdateMessage(uxMessage, "Favorite Added ", Message.DisplayModes.Success);
                else
                    MessageUtilities.UpdateMessage(uxMessage, "Favorite Added with Id " + favoriteItemData.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 a favorite item 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

  • * ID
  • * Object Type

Parameters

  • id. ID of the favorite item to delete.
  • type. Favorite type.

Remarks

Validate the item using GetItem() before deleting.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxFavoriteIdLabel" AssociatedControlID="uxFavoriteId" CssClass="span-4 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxFavoriteId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxFavoriteItemObjectTypeLabel" AssociatedControlID="uxFavoriteItemObjectType" CssClass="span-4 last" runat="server" Text="* Object Type:" />
        <asp:DropDownList ID="uxFavoriteItemObjectType" runat="server">
            <asp:ListItem>Content</asp:ListItem>
            <asp:ListItem>Url</asp:ListItem>
        </asp:DropDownList>
    </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>
 
<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.Common;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long favoriteId = long.Parse(uxFavoriteId.Text);
            FavoriteType favoriteType = (uxFavoriteItemObjectType.SelectedItem.Text == "Content" ? Ektron.Cms.Common.FavoriteType.Content : Ektron.Cms.Common.FavoriteType.Url);

            FavoriteManager favoriteManager = new FavoriteManager();
            favoriteManager.Delete(favoriteId, favoriteType);

            MessageUtilities.UpdateMessage(uxMessage, "Favorite deleted.", Message.DisplayModes.Success);
            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 FavoriteItemData 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

  • * ID
  • * Object Type

Parameters

  • id. ID of the favorite item to get.
  • type. Favorite type.

.aspx code snippet

<ol class="formFields">
        <li class="clearfix">
            <ektronUI:Label ID="uxFavoriteIdLabel" AssociatedControlID="uxFavoriteId" CssClass="span-4 last" runat="server" Text="* Id:" />
            <ektronUI:TextField ID="uxFavoriteId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
        </li> 
        <li class="clearfix" style="color: red;">
            <ektronUI:Label ID="uxStatus" Visible="false" CssClass="span-9 last" runat="server"
                Text="Status:" />
        </li>                  
        <li class="clearfix">
            <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetItem"></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="uxTitle" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxUserId" runat="server"></asp:Literal>
    </li>
        <li class="clearfix">
        <asp:Literal ID="uxFavoriteFolderId" runat="server"></asp:Literal>
    </li>
        <li class="clearfix">
        <asp:Literal ID="uxObjectId" runat="server"></asp:Literal>
    </li>
        <li class="clearfix">
        <asp:Literal ID="uxObjectType" runat="server"></asp:Literal>
    </li>
        <li class="clearfix">
        <asp:Literal ID="uxUrl" 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.Common;
using Ektron.Cms.Framework.Community;
using Ektron.Cms.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long favoriteId = long.Parse(uxFavoriteId.Text);
			FavoriteType favoriteType = (uxFavoriteItemObjectType.SelectedItem.Text == "Content" ? Ektron.Cms.Common.FavoriteType.Content : Ektron.Cms.Common.FavoriteType.Url);

            Ektron.Cms.Framework.Community.FavoriteManager favoriteManager = new Ektron.Cms.Framework.Community.FavoriteManager();
            FavoriteItemData favoriteItemData = favoriteManager.GetItem(favoriteId, favoriteType);
            if (favoriteItemData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for favorite folder with ID " + favoriteItemData.Id.ToString() + " are below", Message.DisplayModes.Success);
                uxTitle.Text = "Title : " + favoriteItemData.Title;
                uxUserId.Text = "User Id : " + favoriteItemData.UserId;
                uxFavoriteFolderId.Text = "Taxonomy Id : " + favoriteItemData.TaxonomyId;
                uxObjectId.Text = "ObjectId: " + favoriteItemData.ObjectId;
                uxObjectType.Text = "ObjectType : " + favoriteItemData.ObjectType;
                uxUrl.Text = "Url : " + favoriteItemData.Url;
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid Favorite Id.", Message.DisplayModes.Error);
                return;
            }

            uxPageMultiView.SetActiveView(uxViewMessage);

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

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

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

  • Favorite Item Property
  • * Object Value

Parameters

  • criteria. Criteria used to retrieve objects

Returns

A list of FavoriteItemData.

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="uxFavoriteItemPropertyLabel" AssociatedControlID="uxFavoriteItemProperty"
            CssClass="span-6 last" runat="server" Text="FavoriteItem Property:" />
        <asp:DropDownList ID="uxFavoriteItemProperty" runat="server">
            <asp:ListItem>UserId</asp:ListItem>
            <asp:ListItem>Id</asp:ListItem>
            <asp:ListItem>FavoriteFolderId</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"
            Text="1" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetList"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
    </li>
</ol>
          
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
<asp:ListView ID="uxFavoriteItemListView" 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>
                        Title
                    </th>                               
                    <th>
                        FavoriteTaxonomyId
                    </th>
                    <th>
                        ObjectId
                    </th>
                    <th>
                        ObjectType
                    </th>
                    <th>
                        UserId
                    </th>
                    <th>
                        Url
                    </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("Title")%>
            </td>                       
            <td class="devsite-method">
                <%# Eval("TaxonomyId ")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ObjectId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ObjectType")%>
            </td>
            <td class="devsite-method">
                <%# Eval("UserId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Url")%>
            </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.Common;
using Ektron.Cms.Framework.Community;
using Ektron.Cms.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            Ektron.Cms.Framework.Community.FavoriteManager favoriteManager = new Ektron.Cms.Framework.Community.FavoriteManager();
            FavoriteItemCriteria criteria = new Ektron.Cms.Community.FavoriteItemCriteria(FavoriteItemProperty.id, EkEnumeration.OrderByDirection.Ascending);

            object Objectvalue;
            string Property = uxFavoriteItemProperty.SelectedItem.Text;
            Objectvalue = Convert.ToInt64(uxObjectValue.Text);

            if (Property == "Id")
            {
                criteria.AddFilter(FavoriteItemProperty.id, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (Property == "FavoriteTaxonomyId")
            {
                criteria.AddFilter(FavoriteItemProperty.FavoriteTaxonomyId, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                criteria.AddFilter(FavoriteItemProperty.UserId, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            List<FavoriteItemData> uxFavoriteItemList = favoriteManager.GetList(criteria);

            uxFavoriteItemListView.Visible = true;
            uxFavoriteItemListView.DataSource = uxFavoriteItemList;
            uxFavoriteItemListView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);

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

Update

Update(Ektron.Cms.FavoriteItemData)

Update an existing favorite 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

  • * ID
  • * Title
  • * Object Type
  • * Object Value
  • Description

Parameters

  • favoriteItemData. The FavoriteItemData object to update.

Returns

Returns the custom FavoriteItemData object that was updated.

Remarks

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

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

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxFavoriteIdLabel" AssociatedControlID="uxFavoriteId" CssClass="span-4 last" runat="server" Text="*Id:" />
        <ektronUI:TextField ID="uxFavoriteId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"  />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxTitlelabel" AssociatedControlID="uxTitle" CssClass="span-4 last" runat="server" Text="* Title:" />
        <ektronUI:TextField ID="uxTitle" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"  />
    </li>           
    <li class="clearfix">
        <ektronUI:Label ID="uxFavoriteItemObjectTypeLabel" AssociatedControlID="uxFavoriteItemObjectType" CssClass="span-4 last" runat="server" Text="* Object Type:" />
        <asp:DropDownList ID="uxFavoriteItemObjectType" runat="server">
            <asp:ListItem>Url</asp:ListItem>
        </asp:DropDownList>
    </li>
        <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-4 last" runat="server" Text="* Object Value:" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"  />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxDescriptionLabel" AssociatedControlID="uxDescription" CssClass="span-4 last" runat="server" Text=" Description:" />
        <asp:TextBox TextMode="MultiLine" Rows="3"  ID="uxDescription" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
        <li class="clearfix" style="color: red;">
                <ektronUI:Label ID="uxStatus" Visible="false" CssClass="span-9 last" runat="server"
                    Text="Status:" />
            </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Update"></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.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            Ektron.Cms.Framework.Community.FavoriteManager favoriteManager = new Ektron.Cms.Framework.Community.FavoriteManager();
            FavoriteItemData favoriteItemData = new FavoriteItemData();

            long favoriteId = long.Parse(uxFavoriteId.Text);

            favoriteItemData = favoriteManager.GetItem(favoriteId, Ektron.Cms.Common.FavoriteType.Url);
            if (favoriteItemData != null)
            {
                favoriteItemData.Title = uxTitle.Text != string.Empty ? uxTitle.Text : favoriteItemData.Title;
                favoriteItemData.Description = uxDescription.Text != string.Empty ? uxDescription.Text : favoriteItemData.Description;
                favoriteItemData.Url = uxObjectValue.Text != string.Empty ? uxObjectValue.Text : favoriteItemData.Url;
                favoriteItemData.ObjectType = Ektron.Cms.Common.FavoriteType.Url;
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid Favorite Id.", Message.DisplayModes.Error);
                return;
            }

            favoriteManager.Update(favoriteItemData);
            MessageUtilities.UpdateMessage(uxMessage, "Favorite Updated", Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);

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

Data Classes

FavoriteItemCriteria

Namespace

Ektron.Cms.Community

Constructors

  • FavoriteItemCriteria()
    public FavoriteItemCriteria()
  • FavoriteItemCriteria(Ektron.Cms.Common.FavoriteItemProperty, EkEnumeration.OrderByDirection)
    public FavoriteItemCriteria(Ektron.Cms.Common.FavoriteItemProperty
  orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the FavoriteItemProperty are:

    • Description
    • FavoriteTaxonomyId
    • FavoriteType
    • Id
    • ObjectId
    • Title
    • Url
    • UserId

FavoriteItemData

Namespace

Ektron.Cms.Community

Properties

  • Description. Gets or sets the description of the favorite.
    public string Description { set; get; }
  • Id. Gets or sets the ID of the CMS Data object. This property is inherited from the CMSData base class and is not applicable to FavoriteItemData. FavoriteItemData does not have a unique ID.
    public override long Id { set; get; }
  • ObjectId. Gets or sets the Id of the favorite object. This would be the content ID if the favorite type is Content.
    public long ObjectId { set; get; }
  • ObjectType. Gets or sets the Favorite type.
    public Ektron.Cms.Common.FavoriteType ObjectType { set; get; }
  • TaxonomyId. Gets or sets the ID of the Taxonomy Node this favorite Item saved in.
    public long TaxonomyId { set; get; }
  • Title. Gets or sets the Title of the favorite. If its a content favorite, this is the content title and cannot be changed. If its a URL favorite, then it can be set.
    public string Title { set; get; }
  • Url. Gets or sets the URL of the favorite.
    public string Url { set; get; }
  • UserId. Gets or setsa the User ID whom this favorite Item belongs to.
    public long UserId { set; get; }