FriendsManager

The FriendsManager class manages colleague connections (friends).

Namespace

Ektron.Cms.Framework.Community.FriendsManager

Constructors

  • FriendsManager()
  • FriendsManager(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.
  • FriendsManagerService. Returns an instance of the business objects friends 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

AcceptInvite

AcceptInvite(Ektron.Cms.Community.PendingFriendsData)

Accepts a friend's invitation.

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

  • * Pending Friend ID

Parameters

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxFriendIdLabel" AssociatedControlID="uxFriendId" CssClass="span-4 last" runat="server" Text="* Pending Friend Id:" />
        <ektronUI:TextField ID="uxFriendId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
                       
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Accept Invite"></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.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            friendId = long.Parse(uxFriendId.Text);
           
            FriendsManager friendsManager = new FriendsManager();
            List<PendingFriendsData> pendingFriendsData = friendsManager.GetPendingList(friendsManager.RequestInformation.UserId);

            PendingFriendsData selectedFriend = pendingFriendsData.FirstOrDefault(x => x.UserId == friendId);
            if (selectedFriend != null)
            {
                friendsManager.AcceptInvite(selectedFriend);
                MessageUtilities.UpdateMessage(uxMessage,"Invite accepted. ", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Invite not found. ", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Add

Add(Ektron.Cms.FriendsData)

Adds a friends data object. When you add the FriendsData, the method returns a Friends 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

  • * Friend User ID

Parameters

  • friendsData. The FriendsData object to add.

Returns

Returns the custom FriendsData object added.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxFriendUserIdlabel" AssociatedControlID="uxFriendUserId" CssClass="span-4 last" runat="server" Text="* Friend UserId:" />
        <ektronUI:TextField ID="uxFriendUserId" 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="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.Framework.Community;
using Ektron.Cms.Framework.User;
using Ektron.Cms;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            FriendsManager friendsManager = new FriendsManager();
            UserManager Usermanager = new UserManager();
            long UserId = long.Parse(uxFriendUserId.Text);
            //Check Whether Entered UserId is Valid or Not.
            UserData Userdata = Usermanager.GetItem(UserId);
            if (Userdata != null)
            {

                FriendsData friendsData = new FriendsData()
                {
                    FriendUserId = UserId,
                    UserId = friendsManager.RequestInformation.UserId
                    //TaxonomyId = 305
                };

                friendsManager.Add(friendsData);
                MessageUtilities.UpdateMessage(uxMessage,  "Friend Added", Message.DisplayModes.Success);
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid User ID and Try again.", Message.DisplayModes.Error);
                return;
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

DeclineInvite

DeclineInvite(PendingFriendsData)

Declines a friend invitation.

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

  • * Pending Friend ID

Parameters

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxFriendIdLabel" AssociatedControlID="uxFriendId" CssClass="span-4 last" runat="server" Text="* Pending Friend Id:" />
        <ektronUI:TextField ID="uxFriendId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
                       
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Decline Invite"></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.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            friendId = long.Parse(uxFriendId.Text);

            FriendsManager friendsManager = new FriendsManager();
            List<PendingFriendsData> pendingFriendsData = friendsManager.GetPendingList(friendsManager.RequestInformation.UserId);

            PendingFriendsData selectedFriend = pendingFriendsData.Find(FindFriend);
            if (selectedFriend != null)
            {
                friendsManager.DeclineInvite(selectedFriend);
                MessageUtilities.UpdateMessage(uxMessage, "Invite declined. ", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Invite not found. ", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

    protected bool FindFriend(PendingFriendsData pendingFriend)
    {
        if (pendingFriend.UserId == friendId)
            return true;
        else
            return false;
    }

Delete (friend)

Delete(System.Int64)

Deletes a friend object 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

Parameters

  • friendId. The ID of the friend to delete.

Remarks

Validate the item using GetItem() before deleting.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxFriendIdLabel" AssociatedControlID="uxFriendId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxFriendId" 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="Delete"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" 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.Community;
using Ektron.Cms.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long friendId = long.Parse(uxFriendId.Text);

            FriendsManager friendsManager = new FriendsManager();
            FriendsData friendsData = friendsManager.GetItem(friendId);

            if (friendsData != null)
            {
                friendsManager.Delete(friendId);
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid Friend ID.", Message.DisplayModes.Error);
                return;
            }
            
            MessageUtilities.UpdateMessage(uxMessage, "Friend with Id " + friendId + " deleted.", Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Delete (user's friend)

Delete(System.Int64)

Deletes a specified user's Friend.

Authenticated users

  • CMS Administrators

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

Fields

*=Required

  • * User ID
  • * Friend ID

Parameters

  • friendId. The ID of the friend to delete.
  • userId. ID of user deleting friend.

Remarks

Validate the item using GetItem() before deleting.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-3 last" runat="server" Text="* User Id:" />
        <ektronUI:TextField ID="uxUserId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxFriendIdLabel" AssociatedControlID="uxFriendId" CssClass="span-3 last" runat="server" Text="* Friend Id:" />
        <ektronUI:TextField ID="uxFriendId" 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="Delete"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" 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.Community;
using Ektron.Cms.Community;
using Ektron.Cms.Framework.User;
using Ektron.Cms;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long userId = long.Parse(uxUserId.Text);
            long friendId = long.Parse(uxFriendId.Text);

            FriendsManager friendsManager = new FriendsManager();
            UserManager Usermanager = new UserManager();
            FriendsData friendsData = friendsManager.GetItem(friendId);

            if (friendsData != null)
            {
                UserData userdata = Usermanager.GetItem(userId);
                if (userdata != null)
                {
                    friendsManager.Delete(friendId, userId);
                }
                else
                {
                    uxStatus.Visible = true;
                    MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid User ID.", Message.DisplayModes.Error);
                    return;
                }
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid Friend ID.", Message.DisplayModes.Error);
                return;
            }

            MessageUtilities.UpdateMessage(uxMessage, "Friend with Id " + friendId + " deleted.", Message.DisplayModes.Success);

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

GetInvitedList

GetInvitedList(System.Int64)

Retrieves a list of PendingFriendsData objects that have an Invited state.

Authenticated users

  • CMS Administrators

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

Fields

*=Required

  • * User ID

Parameters

  • userId. ID used to retrieve friends.

.aspx code snippet

<ol class="formFields">
    <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:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get List"></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="uxPendingFriendsDataListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        User Id
                    </th>
                    <th>
                        InvitationId
                    </th>
                    <th>
                        Friend User Id
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("UserId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("InvitationId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("FriendUserId")%>
            </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.Community;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long userId = long.Parse(uxUserId.Text);

            FriendsManager friendsManager = new FriendsManager();
            List<PendingFriendsData> pendingFriendsData = friendsManager.GetInvitedList(userId);

            uxPendingFriendsDataListView.Visible = true;
            uxPendingFriendsDataListView.DataSource = pendingFriendsData;
            uxPendingFriendsDataListView.DataBind();

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

GetItem (ID)

GetItem(System.Int64)

Retrieves the properties of a specific FriendsData 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

  • friendId. The ID of the user's friend to retrieve.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxFriendIdLabel" AssociatedControlID="uxFriendId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxFriendId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Item"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" 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="uxName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxUserId" 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.Community;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long friendId = long.Parse(uxFriendId.Text);

            FriendsManager friendsManager = new FriendsManager();
            FriendsData friendsData = friendsManager.GetItem(friendId);

            if (friendsData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for friend with ID " + friendsData.FriendUserId.ToString() + " are below", Message.DisplayModes.Success);
                uxName.Text = "Name : " + friendsData.DisplayName;
                uxUserId.Text = "User Id : " + friendsData.UserId;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Friend does not exists. ", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetItem (ID,ID)

GetItem(System.Int64,System.Int64)

Retrieves the properties of a specific FriendsData 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

  • * User ID
  • * Friend ID

Parameters

  • friendId. The ID of the user's friend to retrieve.
  • userId. The ID of the user.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-3 last"
            runat="server" Text="*User Id:" />
        <ektronUI:TextField ID="uxUserId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxFriendIdLabel" AssociatedControlID="uxFriendId" CssClass="span-3 last"
            runat="server" Text="*Friend Id:" />
        <ektronUI:TextField ID="uxFriendId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Message ID="uxStatus" DisplayMode="Error" runat="server" Visible="false" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Item"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" 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="uxName" 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.Community;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long friendId = long.Parse(uxFriendId.Text);
            long userId = long.Parse(uxUserId.Text);

            FriendsManager friendsManager = new FriendsManager();
            FriendsData friendsData = friendsManager.GetItem(friendId, userId);

            if (friendsData != null)
            {
                uxMessage.Text = "Details for friend with ID " + friendsData.FriendUserId.ToString() + " are below";
                uxName.Text = "Name : " + friendsData.DisplayName;                
            }
            else
            {
                uxMessage.Text = "Friend does not exists. ";
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            uxMessage.Text = ex.Message;
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetList

GetList(FriendsCriteria)

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

  • * Friends Data Property
  • * Object Value

Parameters

  • criteria. Criteria used to retrieve friends.

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="uxFriendsDataPropertyLabel" AssociatedControlID="uxFriendsDataProperty" CssClass="span-4 last" runat="server" Text="* FriendsDataProperty:" />
        <asp:DropDownList ID="uxFriendsDataProperty" runat="server">
            <asp:ListItem>FriendUserId</asp:ListItem>
            <asp:ListItem>UserId</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-4 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-4" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
            
<asp:ListView ID="uxfriendsDataListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        User Id
                    </th>
                    <th>
                        First Name
                    </th>
                    <th>
                        Friend UserId
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("UserId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("FirstName")%>
            </td>
            <td class="devsite-method">
                <%# Eval("FriendUserId")%>
            </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.Community;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

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

            FriendsCriteria criteria = new FriendsCriteria(FriendsProperty.UserId, EkEnumeration.OrderByDirection.Ascending);
            if (uxFriendsDataProperty.SelectedItem.Text == "FriendUserId")
            {
                Objectvalue = Convert.ToInt64(uxObjectValue.Text);
                criteria.AddFilter(FriendsProperty.FriendUserId, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(FriendsProperty.UserId, CriteriaFilterOperator.EqualTo, Objectvalue);
            }

            FriendsManager friendsManager = new FriendsManager();
            List<FriendsData> friendsDataList = friendsManager.GetList(criteria);

            uxfriendsDataListView.Visible = true;
            uxfriendsDataListView.DataSource = friendsDataList;
            uxfriendsDataListView.DataBind();

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

GetPendingList

GetPendingList(System.Int64)

Retrieves a list of PendingFriendsData objects that have a Pending state.

Authenticated users

  • CMS Administrators

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

Fields

*=Required

  • * User ID

Parameters

  • userId. ID used to retrieve friends.

.aspx code snippet

<ol class="formFields">
    <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:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get List"></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="uxPendingFriendsDataListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        User Id
                    </th>
                    <th>
                        InvitationId
                    </th>
                    <th>
                        Friend User Id
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("UserId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("InvitationId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("FriendUserId")%>
            </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.Community;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long userId = long.Parse(uxUserId.Text );

            FriendsManager friendsManager = new FriendsManager();
            List<PendingFriendsData> pendingFriendsData = friendsManager.GetPendingList(userId);

            uxPendingFriendsDataListView.Visible = true;
            uxPendingFriendsDataListView.DataSource = pendingFriendsData;
            uxPendingFriendsDataListView.DataBind();

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

Invites a user to be your friend.

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

  • * Friend ID
  • * Subject
  • * Message

Parameters

  • friendId. User ID of person to invite as a friend.
  • subject. Subject of the invitation to be sent.
  • message. Message of the invitation to be sent.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxFriendIdLabel" AssociatedControlID="uxFriendId" CssClass="span-4 last" runat="server" Text="* Friend Id:" />
        <ektronUI:TextField ID="uxFriendId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxSubjectlabel" AssociatedControlID="uxSubject" CssClass="span-4 last" runat="server" Text="* Subject:" />
        <ektronUI:TextField ID="uxSubject" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
        <li class="clearfix">
        <ektronUI:Label ID="uxMessageLabel" AssociatedControlID="uxInviteMessage" CssClass="span-4 last" runat="server" Text="* Message:" />
        <asp:TextBox TextMode="MultiLine" Rows="3"  ID="uxInviteMessage" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Invite"></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.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long friendId = long.Parse(uxFriendId.Text);

            FriendsManager friendsManager = new FriendsManager();
            friendsManager.Invite(friendId, uxSubject.Text, uxInviteMessage.Text);

            MessageUtilities.UpdateMessage(uxMessage, "Invite sent. ", Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }
Invite(Ektron.Cms.Common.invitationSendRequestData)

Invites a user to be your friend.

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

  • * Friend ID

Parameters

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxFriendIdLabel" AssociatedControlID="uxFriendId" CssClass="span-4 last" runat="server" Text="* Friend Id:" />
        <ektronUI:TextField ID="uxFriendId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
   
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Invite"></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.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long friendId = long.Parse(uxFriendId.Text);

            FriendsManager friendsManager = new FriendsManager();

            var invitationRequestData = new InvitationSendRequestData();
            invitationRequestData.UserIds.Add(friendId);

            friendsManager.Invite(invitationRequestData);

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

IsFriend

IsFriend(System.Int64)

Check the user is friend to the currently logged in user.

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

  • * Friend ID

Parameters

  • friendId. Friend ID.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxFriendIdLabel" AssociatedControlID="uxFriendId" CssClass="span-4 last" runat="server" Text="* Friend Id:" />
        <ektronUI:TextField ID="uxFriendId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>   
    <li class="clearfix">
        <ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Invite"></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.Community;
using Ektron.Site.Developer;
using Ektron.Cms.Framework.UI.Controls.EktronUI;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long friendId = long.Parse(uxFriendId.Text);

            FriendsManager friendsManager = new FriendsManager();
            if (friendsManager.IsFriend(long.Parse(uxFriendId.Text)))
            {
                MessageUtilities.UpdateMessage(uxMessage, uxFriendId.Text +" is friend to "+new Ektron.Cms.ContentAPI().UserId , Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, uxFriendId.Text +" is not friend", Message.DisplayModes.Success);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Update

Update(Ektron.Cms.FriendsData)

Updates an existing Friends 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

  • * Friend ID
  • * Folder ID

Parameters

  • friendsData. The FriendsData object to update.

Returns

Returns the custom FriendsData object that was updated.

Remarks

Validate the Friends ID and Folder ID with GetItem() before you update the properties. Then, call Update with your modified FriendsData object.

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

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxFriendIdLabel" AssociatedControlID="uxFriendId" CssClass="span-4 last" runat="server" Text="* Friend Id:" />
        <ektronUI:TextField ID="uxFriendId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxFolderIdlabel" AssociatedControlID="uxFolderId" CssClass="span-4 last" runat="server" Text="* Folder Id:" />
        <ektronUI:TextField ID="uxFolderId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </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;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            long friendId = long.Parse(uxFriendId.Text);

            FriendsManager friendsManager = new FriendsManager();
            FriendsData friendsData = friendsManager.GetItem(friendId);

            if (friendsData != null)
            {
                friendsData.FriendUserId = friendId;
                friendsData.TaxonomyId = (uxFolderId.Text != string.Empty ? long.Parse(uxFolderId.Text) : friendsData.TaxonomyId);
                friendsManager.Update(friendsData);
                MessageUtilities.UpdateMessage(uxMessage, "Friend updated", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Friend does not exists. ", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Data Classes

FriendsCriteria

Namespace

Ektron.Cms.Community

Constructors

  • FriendsCriteria()
    public FriendsCriteria()
  • FriendsCriteria(Ektron.Cms.Common.FriendsProperty, EkEnumeration.OrderByDirection)
    public FriendsCriteria(Ektron.Cms.Common.FriendsProperty
  orderByField, EkEnumeration.OrderByDirection orderByDirection)

    Accepted fields for the FriendsProperty are:

    • FriendsUserId
    • TaxonomyId
    • TaxonomyName
    • TaxonomyPath
    • UserId

FriendsData

Namespace

Ektron.Cms.Community

Properties

  • Avatar
    public string Avatar { set; get; }
  • DisplayName
    public string DisplayName { set; get; }
  • Email
    public string Email { set; get; }
  • FirstName
    public string FirstName { set; get; }
  • FriendsUserId. Gets or sets the UserId of the friend being added.
    public long FriendUserId { set; get; }
  • LastName
    public string LastName { set; get; }
  • TaxonomyId. ID of the Taxonomy to put the friend in for User ID. If not set, it will go in the users root Friends taxonomy folder.
    public long TaxonomyId { set; get; }
  • UserId. Gets or sets the ID of the user who is adding the friend.
    public long UserId { set; get; }
  • Username
    public string Username { set; get; }

InvitationSendRequestData

Namespace

Ektron.Cms.Common

Properties

  • EmailAddress
    public System.Collections.ObjectModel.Collection<string>
   EmailAddresses { get; }
  • InvitationSendRequestData()
    public InvitationSendRequestData()
  • NonuserMessageId
    public long NonuserMessageId { set; get; }
  • OptionalText
    public string OptionalText { set; get; }
  • SenderId
    public long SenderId { set; get; }
  • UserIds. Gets or sets the ID of the user who is adding the friend.
    public System.Collections.ObjectModel.Collection<long>
  UserIds { get; }
  • UserMessageId. Gets or sets the UserId of the friend being added.
    public long UserMessageId { set; get; }

PendingFriendsData

Namespace

Ektron.Cms.Community

Properties

  • InvitationId
    public long InvitationId { set; get; }