FlagManager

Add

Add(Ektron.Cms.ObjectFlagData)

Adds a flag to community content whose ID is specified in the objectFlagData.

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

• * Object Type
• * Object ID
• * Flag Option
• Flag Comment

Parameters

• objectFlagData. The ObjectFlagData object.

Remarks

Before using this add method, define a flag. Do this by logging into the CMS and navigating to Workarea > Settings > Community Management > Flagging > Community Flagging Definition.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxFlagObjectTypeLabel" AssociatedControlID="uxFlagObjectType" CssClass="span-4 last" runat="server" Text="* Object Type:" />
        <asp:DropDownList ID="uxFlagObjectType" runat="server">
            <asp:ListItem>Content</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-4 last" runat="server" Text="* Object Id:" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="30"  />
    </li>
    <li class="clearfix">
                <ektronUI:Label ID="uxFlagOptionLabel" AssociatedControlID="uxFlagOption" CssClass="span-6 last" runat="server" Text="* Flag Option:" />
                <asp:DropDownList ID="uxFlagOption" runat="server">
                    <asp:ListItem Value="1">Inappropriate</asp:ListItem>
                    <asp:ListItem Value="2">OffensiveContent</asp:ListItem>
                    <asp:ListItem Value="3">CopyrightViolation</asp:ListItem>
                </asp:DropDownList>
            </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxFlagCommentLabel" AssociatedControlID="uxFlagComment" CssClass="span-4 last" runat="server" Text=" Flag Comment:" />
        <asp:TextBox TextMode="MultiLine" Rows="3"  ID="uxFlagComment" 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;
using Ektron.Cms.Framework.Community;
using Ektron.Cms.Framework.Content;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            string visitorId = string.Empty;
            if (Page.Request.Cookies["ekContentRatingID"] == null)
            {
                visitorId = (string)(System.Guid.NewGuid().ToString().Replace("-", ""));
                Page.Response.Cookies.Add(new System.Web.HttpCookie("ekContentRatingID", visitorId));
                Page.Response.Cookies["ekContentRatingID"].Expires = DateTime.MaxValue;
            }
            else
            {
                visitorId = Page.Request.Cookies["ekContentRatingID"].Value;
            }
            ContentManager contentManager = new ContentManager();
            ContentData cData = new ContentData();
            long contentID = long.Parse(uxObjectValue.Text);

            cData = contentManager.GetItem(contentID, false);
            if (cData != null && cData.IsPublished)
            {

                FlagManager flagManager = new FlagManager();

                long option = 1;
                option = long.Parse(uxFlagOption.SelectedValue);


                ObjectFlagData objectFlagData = new ObjectFlagData()
                {
                    ObjectType = Ektron.Cms.Common.EkEnumeration.CMSObjectTypes.Content,
                    ObjectId = contentID,
                    UserId = flagManager.RequestInformation.UserId,
                    VisitorID = visitorId,
                    Comment  = uxFlagComment.Text,                    
                    FlagOptionId = option,
                };

                flagManager.Add(objectFlagData);
                MessageUtilities.UpdateMessage(uxMessage, "Content Flag Added with Id " + objectFlagData.Id, Message.DisplayModes.Success);
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid Content ID.", Message.DisplayModes.Error);
                return;
            }
            uxPageMultiView.SetActiveView(uxViewMessage);

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

Delete

Delete(System.Int64)

Deletes a flag from community content whose ID is specified in the objectFlagData.

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

• * Object Flag ID

Parameters

• objectFlagId. The ID of the ObjectFlagData type to be deleted.

Remarks

Validate the item using GetItem() before deleting.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectFlagIdLabel" AssociatedControlID="uxObjectFlagId" CssClass="span-4 last" runat="server" Text="* Object Flag Id:" />
        <ektronUI:TextField ID="uxObjectFlagId" 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-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.Cms;

.aspx.cs code-behind method

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

            FlagManager flagManager = new FlagManager();
            ObjectFlagData objectFlagData = flagManager.GetItem(objectFlagId);

            if (objectFlagData != null)
            {
                flagManager.Delete(objectFlagId);
                MessageUtilities.UpdateMessage(uxMessage, "Flag deleted.", Message.DisplayModes.Success);
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus,  "Please Enter Valid Flag 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 FlagData 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

Parameters

• objectFlagId. The ID of the ObjectFlagData type to get.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectFlagIdLabel" AssociatedControlID="uxObjectFlagId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxObjectFlagId" 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="uxObjectType" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxObjectId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxUserId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxFlagComment" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxFlagDate" 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.Framework.Community;

.aspx.cs code-behind method

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

            FlagManager flagManager = new FlagManager();
            ObjectFlagData objectFlagData = flagManager.GetItem(objectFlagId);

            if (objectFlagData != null)
            {
                MessageUtilities.UpdateMessage(uxMessage,  "Details for Flag with ID " + objectFlagId.ToString() + " are below", Message.DisplayModes.Success);
                uxObjectType.Text = "Object Type : " + (Ektron.Cms.Common.EkEnumeration.CMSObjectTypes)objectFlagData.ObjectType;
                uxObjectId.Text = "Object Id : " + objectFlagData.ObjectId;
                uxUserId.Text = "User Id : " + objectFlagData.UserId;
                uxFlagComment.Text = "Flag Comment : " + objectFlagData.Comment;
                uxFlagDate.Text = "Flag Date :" + objectFlagData.Date;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Flag does not exists. ", Message.DisplayModes.Error);
            }

            uxPageMultiView.SetActiveView(uxViewMessage);

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

GetList

GetList(Ektron.Cms.Community.FlagCriteria)

Retrieves lists of objects.

Authenticated users

• CMS Administrators
• Users that have access permission

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

Fields

*=Required

• Object Flag Data Property
• * Object Value

Parameters

• criteria. FlagCriteria used to retrieve content.

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="uxObjectFlagDataPropertyLabel" AssociatedControlID="uxObjectFlagDataProperty" CssClass="span-6 last" runat="server" Text="Object Flag Data Property:" />
        <asp:DropDownList ID="uxObjectFlagDataProperty" runat="server">
            <asp:ListItem>Flag Entry Id</asp:ListItem>
            <asp:ListItem>Object Id</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-6 last" runat="server" Text="* ObjectValue:" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"  />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get List"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-6" runat="server" Text="* - Required" /> 
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
 
<asp:ListView ID="uxObjectFlagListView" runat="server"  ItemPlaceholderID="aspItemPlaceholder" Visible="false">
    <EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Flag Entry Id
                    </th>
                    <th>
                        Object Id
                    </th>
                    <th>
                        Flag Comment
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("FlagEntryId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ObjectId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("FlagComment")%>
            </td>
        </tr>
    </ItemTemplate>
</asp:ListView>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Cms;
using Ektron.Cms.Common;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

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

            Ektron.Cms.Community.FlagCriteria criteria = new Ektron.Cms.Community.FlagCriteria();
            if (uxObjectFlagDataProperty.SelectedItem.Text == "Flag Entry Id")
            {
                Objectvalue = Convert.ToInt64(uxObjectValue.Text);
                criteria.AddFilter(ObjectFlagDataProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(ObjectFlagDataProperty.ObjectId , CriteriaFilterOperator.EqualTo , Objectvalue);
            }

            FlagManager flagManager = new FlagManager();
            List<ObjectFlagData> objectFlagDataList = flagManager.GetList(criteria);

            uxObjectFlagListView.Visible = true;
            uxObjectFlagListView.DataSource = objectFlagDataList;
            uxObjectFlagListView.DataBind();

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

Update

Update(Ektron.Cms.ObjectFlagData)

Updates an existing ObjectFlag 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
• Flag Option
• Flag Comment

Parameters

• objectFlagData. The flag object.

Returns

Returns the custom ObjectFlagData object updated.

Remarks

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

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

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectFlagIdLabel" AssociatedControlID="uxObjectFlagId" CssClass="span-3 last" runat="server" Text="* Id :" />
        <ektronUI:TextField ID="uxObjectFlagId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
        <li class="clearfix">
        <ektronUI:Label ID="uxFlagItemIdLabel" AssociatedControlID="uxFlagItemId" CssClass="span-3 last" runat="server" Text=" Flag Item Id:" />
        <ektronUI:TextField ID="uxFlagItemId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"  />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxFlagCommentLabel" AssociatedControlID="uxFlagComment" CssClass="span-3 last" runat="server" Text=" Flag Comment:" />
        <asp:TextBox TextMode="MultiLine" Rows="3"  ID="uxFlagComment" 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-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;
using Ektron.Cms.Framework.Community;

.aspx.cs code-behind method

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

            FlagManager flagManager = new FlagManager();
            ObjectFlagData objectFlagData = flagManager.GetItem(objectFlagId);

            if (objectFlagData != null)
            {
                long option = 0;
                option = long.Parse(uxFlagOption.SelectedValue);
                if (option > 0)
                {
                    objectFlagData.FlagOptionId = option;
                }
                objectFlagData.Comment  = (uxFlagComment.Text != string.Empty ? uxFlagComment.Text : objectFlagData.Comment);               
                
                flagManager.Update(objectFlagData);

                MessageUtilities.UpdateMessage(uxMessage, "Content Flag Updated ", Message.DisplayModes.Success);
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Flag does not exists. ", Message.DisplayModes.Error);
            }

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

FlagCriteria

Namespace

Ektron.Cms.Community

Constructors

• FlagCriteria()

  public FlagCriteria()

• FlagCriteria(Ektron.Cms.Common.FlagProperty, EkEnumeration.OrderByDirection)

  public FlagCriteria(Ektron.Cms.Common.FlagProperty
    orderByField, EkEnumeration.OrderByDirection orderByDirection)

  Accepted fields for the FlagProperty are:

  • Comment
  • Date
  • FlagDefinitionId
  • FlagOptionId
  • Id
  • ObjectId
  • ObjectLanguageId
  • ObjectType
  • UserId
  • VisitorId

ObjectFlagData

Namespace

Ektron.Cms

Properties

• Comment. Gets or sets the comment associated with this flag instance.

  public string Comment { set; get; }

• Date. Gets or sets the Date the object was flagged.

  public System.DateTime Date { set; get; }

• FlagComment

  public string FlagComment { set; get; }

• FlagDate

  public System.DateTime FlagDate { set; get; }

• FlagDefinitionId. Gets the ID of the Flag Definition used by this flag instance. When saving this value is not neccessary and will be derived from FlagOptionId.

  public long FlagDefinitionId { set; get; }

• FlagEntryId

  public long FlagEntryId { set; get; }

• FlagId

  public long FlagId { set; get; }

• FlagItemId

  public long FlagItemId { set; get; }

• FlagOptionId. Gets or sets the ID of the Flag Definition Option that is being chosen for this Flag instance.

  public long FlagOptionId { set; get; }

• Id. Gets the unique ID of this Object Flag Instance once saved.

  public override long Id { set; get; }

• ObjectId. Gets or sets the ID of the object that is being flagged. This property correlates directly with ObjectType. For Example, if ObjectType == Content, then ObjectId would be the Content ID being flagged.

  public long ObjectId { set; get; }

• ObjectLanguageId. Gets or sets the Id of the Language of the object being flagged.

  public int ObjectLanguageId { set; get; }

• ObjectType. Gets or sets the Type of Object being flagged.

  public EkEnumeration.CMSObjectTypes ObjectType { set; get; }

• ToXmlString()

  public string ToXmlString()

• UserId. Gets or sets the Id of the logged in user who is creting this flag instance. If the user is not logged in, use visitorId.

  public long UserId { set; get; }

• VisitorId. Gets or sets the ID of the non-logged in user that performed this flag. This property is only used for users that are not logged in. The CMS trackes these users by a unique visitor ID stored in a cookie and may overwrite value of this property. Logged in users should populate the UserId property.

  public string VisitorID { set; get; }