FriendsTaxonomyManager

The FriendsTaxonomyManager class manages taxonomies of colleague connections (friends).

Namespace

Ektron.Cms.Framework.Community.FriendsTaxonomyManager

Constructors

  • FriendsTaxonomyManager()
  • FriendsTaxonomyManager(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.
  • FriendsFolderManagerService. Returns an instance of the business objects task 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.FriendTaxonomyData)

Adds a friends taxonomy data object.

When you add the friends taxonomy data, 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

  • * Title
  • * Parent ID (Taxonomy ID)
  • Description

Parameters

  • friendFolderData. The FriendTaxonomyData object to add.

Returns

Returns the custom FriendTaxonomyData object added.

.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" Text="Friends"  />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxParentIdLabel" AssociatedControlID="uxParentId" CssClass="span-4 last" runat="server" Text="* Parent Id(Taxonomy Id):" />
        <ektronUI:TextField ID="uxParentId" 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-6" 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;
using Ektron.Cms.Community;
using Ektron.Cms.Framework.Community;
using Ektron.Cms.Framework.Organization;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            FriendsTaxonomyManager friendsTaxonomyManager = new FriendsTaxonomyManager();
            FriendTaxonomyData parentTaxonomy = friendsTaxonomyManager.GetItem(long.Parse(uxParentId.Text));

            if (parentTaxonomy != null)
            {
                FriendTaxonomyData FriendTaxonomyData = new FriendTaxonomyData()
                {
                    Name = uxTitle.Text,
                    ParentId = parentTaxonomy.ParentId,
                    Description = uxDescription.Text
                };

                friendsTaxonomyManager.Add(FriendTaxonomyData);

                MessageUtilities.UpdateMessage(uxMessage, "Friend Taxonomy Added with Id " + FriendTaxonomyData.Id, Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Parent taxonomy does not exists. Please check the parent ID.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Delete

Delete(System.Int64)

Deletes a friends taxonomy 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

Remarks

Validate the item using GetItem() before deleting.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxFriendTaxonomyIdLabel" AssociatedControlID="uxFriendTaxonomyId" CssClass="span-3 last" runat="server" Text="* Id:" />
        <ektronUI:TextField ID="uxFriendTaxonomyId" 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 friendTaxonomyId = long.Parse(uxFriendTaxonomyId.Text);

            FriendsTaxonomyManager friendsTaxonomyManager = new FriendsTaxonomyManager();
            FriendTaxonomyData friendTaxonomyData = friendsTaxonomyManager.GetItem(friendTaxonomyId);

            if (friendTaxonomyData != null)
            {
                friendsTaxonomyManager.Delete(friendTaxonomyId);
                MessageUtilities.UpdateMessage(uxMessage, "Friend Taxonomy deleted.", Message.DisplayModes.Success);
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid Friend Taxonomy Id.", Message.DisplayModes.Error);
                return;
            }
            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 FriendTaxonomyData object.

Authenticated users

  • CMS Administrators

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

Fields

*=Required

  • * ID

Parameters

  • Id. The ID of the FriendTaxonomyData item to get. Internally the folder is stored as Taxonomy so this is the corresponding taxonomy ID.

Returns

FriendTaxonomyData details in a FriendTaxonomyData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxFriendTaxonomyIdLabel" AssociatedControlID="uxFriendTaxonomyId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxFriendTaxonomyId" 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="uxParentId" 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 friendTaxonomyId = long.Parse(uxFriendTaxonomyId.Text);

            FriendsTaxonomyManager friendsTaxonomyManager = new FriendsTaxonomyManager();
            FriendTaxonomyData friendTaxonomyData = friendsTaxonomyManager.GetItem(friendTaxonomyId);

            if (friendTaxonomyData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for friend taxonomy with ID " + friendTaxonomyData.Id.ToString() + " are below", Message.DisplayModes.Success);
                uxName.Text = "Name : " + friendTaxonomyData.Name;
                uxParentId.Text = "Parent Id : " + friendTaxonomyData.ParentId;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Friend taxonomy does not exist. ", Message.DisplayModes.Error);
            }

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

GetTree

GetTree(System.Int64,System.Int32,System.Boolean,Ektron.Cms.PagingInfo)

Retrieves the taxonomy tree of a friend.

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
  • * Depth
  • * Get Items

Parameters

  • id. Taxonomy ID. Internally the folder is stored as Taxonomy so this is the corresponding taxonomy ID.
  • depth. Depth
  • includeItems. Should items be included?
  • pagingInfo. Set paging details.

Returns

FriendTaxonomyData details in a FriendTaxonomyData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxFriendTaxonomyIdLabel" AssociatedControlID="uxFriendTaxonomyId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxFriendTaxonomyId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxDepthLabel" AssociatedControlID="uxDepth" CssClass="span-3 last" runat="server" Text="* Depth :" />
        <ektronUI:TextField ID="uxDepth" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxGetItemsLabel" AssociatedControlID="uxGetItems" CssClass="span-3 last" runat="server" Text="* Get Items:" />
        <ektronUI:Button DisplayMode="Checkbox" Text="" ID="uxGetItems" 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="uxParentId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxItems" 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;
using Ektron.Cms.Community;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            FriendsTaxonomyManager friendsTaxonomyManager = new FriendsTaxonomyManager();
            FriendTaxonomyData friendTaxonomyData = friendsTaxonomyManager.GetTree(long.Parse(uxFriendTaxonomyId.Text), int.Parse(uxDepth.Text), uxGetItems.Checked, new PagingInfo());

            if (friendTaxonomyData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage, "Details for friend Taxonomy with ID " + friendTaxonomyData.Id.ToString() + " are below", Message.DisplayModes.Success);
                uxName.Text = "Name : " + friendTaxonomyData.Name;
                uxParentId.Text = "Parent Id : " + friendTaxonomyData.ParentId;
                uxItems.Text = "Item Count :" + friendTaxonomyData.Items.Count.ToString() ;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Friend Taxonomy does not exist. ", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetUserTaxonomy

GetUserTaxonomy(System.Int64)

Retrieves the taxonomy tree of a friend.

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

  • * User ID

Parameters

  • userId. The user ID of the user for which to retrieve the friends taxonomy.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxFriendTaxonomyIdLabel" AssociatedControlID="uxFriendTaxonomyId" CssClass="span-3 last" runat="server" Text="*User Id :" />
        <ektronUI:TextField ID="uxFriendTaxonomyId" 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="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="uxParentId" 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;
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(uxFriendTaxonomyId.Text);

            UserManager Usermanager = new UserManager(ApiAccessMode.Admin);
            //Check Whether entered UserId valid or Not
            UserData Userdata = Usermanager.GetItem(userId);
            if (Userdata != null)
            {
                FriendsTaxonomyManager friendsTaxonomyManager = new FriendsTaxonomyManager();
                FriendTaxonomyData friendTaxonomyData = friendsTaxonomyManager.GetUserTaxonomy(userId);

                if (friendTaxonomyData != null)
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Details for friend Taxonomy with ID " + friendTaxonomyData.Id.ToString() + " are below", Message.DisplayModes.Success);
                    uxName.Text = "Name : " + friendTaxonomyData.Name;
                    uxParentId.Text = "Parent Id : " + friendTaxonomyData.ParentId;
                    uxFriendsCount.Text = "Friends : " + friendTaxonomyData.Items.Count;
                }
                else
                {
                    uxStatus.Visible = true;
                    MessageUtilities.UpdateMessage(uxStatus, "Friend User Taxonomy does not exist.", Message.DisplayModes.Error);
                    return;
                }
            }
            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);
        }
    }

Update

Update(Ektron.Cms.FriendTaxonomyData)

Updates an existing friends taxonomy 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 Taxonomy ID
  • * Title
  • Description

Parameters

  • friendTaxonomyData. The FriendTaxonomyData object to update.

Returns

Returns the custom FriendTaxonomyData object updated.

Remarks

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

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

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxFriendTaxonomyIdLabel" AssociatedControlID="uxFriendTaxonomyId" CssClass="span-4 last" runat="server" Text="* Friend Taxonomy Id:" />
        <ektronUI:TextField ID="uxFriendTaxonomyId" 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="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="Update"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-6" 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 friendTaxonomyId = long.Parse(uxFriendTaxonomyId.Text);

            FriendsTaxonomyManager friendsTaxonomyManager = new FriendsTaxonomyManager();
            FriendTaxonomyData friendTaxonomyData = friendsTaxonomyManager.GetItem(friendTaxonomyId);

            if (friendTaxonomyData != null)
            {
                friendTaxonomyData.Name = uxTitle.Text != string.Empty ? uxTitle.Text : friendTaxonomyData.Name;
                friendTaxonomyData.Description = uxDescription.Text != string.Empty ? uxDescription.Text : friendTaxonomyData.Description;
                
                friendsTaxonomyManager.Update(friendTaxonomyData);
                MessageUtilities.UpdateMessage(uxMessage,  "Friend Taxonomy updated", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Friend Taxonomy does not exist. ", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

Data Classes

FriendTaxonomyData

Namespace

Ektron.Cms.Community

Properties

  • ChildTaxonomies. Gets or sets the Friends child taxonomy in the current taxonomy. If not retrieved, this will be an empty list.
    public System.Collections.Generic.List<FriendTaxonomyData>
  ChildTaxonomies { set; get; }
  • Description. Gets or sets the description of the taxonomy's folder.
    public string Description { set; get; }
  • FriendTaxonomyData()
    public FriendTaxonomyData()
  • Id. Gets or sets the ID of the Friends taxonomy. Overridden to clarify the description and taxonomy relationship
    public override long Id { set; get; }
  • Items. Gets or sets the Friends in the taxonomy. If not retrieved, this will be an empty list.
    public System.Collections.Generic.List<FriendsData> Items { set; get; }
  • Name. Gets or sets the Friends taxonomy name.
    public string Name { set; get; }
  • ParentId. Gets or sets the ID of the Friends folder's parent taxonomy.
    public long ParentId { set; get; }