PermissionManager

Add

Add(Ektron.Cms.Messaging.UserPermissionData)

Adds a user permission, with details from the supplied UserPermissionData 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

• * Content ID
• * User ID
• Is Membership User
• Is Inherited
• Is Private Content
• Is Read Only
• Can Edit
• Can Add
• Can Delete
• Is Read Only Lib

Parameters

• permissionData

Returns

Returns the custom CmsData object added.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxContentIdLabel" AssociatedControlID="uxContentId" CssClass="span-4 last"
            runat="server" Text="*Content Id:" />
        <ektronUI:TextField ID="uxContentId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="30" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-4 last"
            runat="server" Text="*User Id:" />
        <ektronUI:TextField ID="uxUserId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="10" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIsMembershipUserLabel" AssociatedControlID="uxIsMembershipUser"
            CssClass="span-4 last" runat="server" Text="IsMembershipUser :" />
        <asp:DropDownList ID="uxIsMembershipUser" runat="server" CssClass="span-4 last">
            <asp:ListItem>True</asp:ListItem>
            <asp:ListItem>False</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIsInheritedLabel" AssociatedControlID="uxIsInherited" CssClass="span-4 last"
            runat="server" Text="IsInherited :" />
        <asp:DropDownList ID="uxIsInherited" runat="server" CssClass="span-4 last">
            <asp:ListItem>False</asp:ListItem>
            <asp:ListItem>True</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIsPrivateContentLabel" AssociatedControlID="uxIsPrivateContent"
            CssClass="span-4 last" runat="server" Text="IsPrivateContent :" />
        <asp:DropDownList ID="uxIsPrivateContent" runat="server" CssClass="span-4 last">
            <asp:ListItem>False</asp:ListItem>
            <asp:ListItem>True</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIsReadOnlyLabel" AssociatedControlID="uxIsReadOnly" CssClass="span-4 last"
            runat="server" Text="IsReadOnly :" />
        <asp:DropDownList ID="uxIsReadOnly" runat="server" CssClass="span-4 last">
            <asp:ListItem>True</asp:ListItem>
            <asp:ListItem>False</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCanEditLabel" AssociatedControlID="uxCanEdit" CssClass="span-4 last"
            runat="server" Text="CanEdit :" />
        <asp:DropDownList ID="uxCanEdit" runat="server" CssClass="span-4 last">
            <asp:ListItem>True</asp:ListItem>
            <asp:ListItem>False</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCanAddLabel" AssociatedControlID="uxCanAdd" CssClass="span-4 last"
            runat="server" Text="CanAdd :" />
        <asp:DropDownList ID="uxCanAdd" runat="server" CssClass="span-4 last">
            <asp:ListItem>True</asp:ListItem>
            <asp:ListItem>False</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCanDeleteLabel" AssociatedControlID="uxCanDelete" CssClass="span-4 last"
            runat="server" Text="CanDelete :" />
        <asp:DropDownList ID="uxCanDelete" runat="server" CssClass="span-4 last">
            <asp:ListItem>True</asp:ListItem>
            <asp:ListItem>False</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIsReadOnlyLibLabel" AssociatedControlID="uxIsReadOnlyLib" CssClass="span-4 last"
            runat="server" Text="IsReadOnlyLib :" />
        <asp:DropDownList ID="uxIsReadOnlyLib" runat="server" CssClass="span-4 last">
            <asp:ListItem>True</asp:ListItem>
            <asp:ListItem>False</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix" style="color: red;">
        <ektronUI:Label ID="uxStatus" Visible="false" CssClass="span-9 last" runat="server"
            Text="Status:" />
    </li>
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add"></ektronUI:Button>
    <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Settings;
using Ektron.Cms.Framework.User;
using Microsoft.VisualBasic;
using Ektron.Cms.Framework.Content;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            PermissionManager permissionManager = new PermissionManager();
            UserManager Usermanager = new UserManager();
            long UserId = long.Parse(uxUserId.Text);
            //Check whether entered UserID is Valid or Not
            UserData Userdata = Usermanager.GetItem(UserId);
            if (Userdata != null && Userdata.IsDeleted == false)
            {
                ContentManager contentManager = new ContentManager();
                long contentID = long.Parse(uxContentId.Text);
                bool result = Information.IsNumeric(uxContentId.Text);
                ContentData contentData = contentManager.GetItem(contentID);
                //Check whether entered ContentID is Valid or Not
                if (!((result) && contentData != null))
                {
                    uxStatus.Visible = true;
                    MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid content ID ", Message.DisplayModes.Error);
                    return;
                }
                else
                {
                    //Set the UserPermission Details
                    UserPermissionData userPermissionData = new UserPermissionData()
                    {
                        ContentId = contentID,
                        FolderId = contentData.FolderId,
                        UserId = UserId,
                        IsInherited = bool.Parse(uxIsInherited.SelectedValue),
                        IsPrivateContent = bool.Parse(uxIsPrivateContent.SelectedValue),
                        IsReadOnly = bool.Parse(uxIsReadOnly.SelectedValue),
                        CanEdit = bool.Parse(uxCanEdit.SelectedValue),
                        CanAdd = bool.Parse(uxCanAdd.SelectedValue),
                        CanDelete = bool.Parse(uxCanDelete.SelectedValue),
                        IsReadOnlyLib = bool.Parse(uxIsReadOnlyLib.SelectedValue),
                        IsMembershipUser = bool.Parse(uxIsMembershipUser.SelectedValue),
                    };
                    //Add a New UserPermissionData with Given Details
                    permissionManager.Add(userPermissionData);
                    MessageUtilities.UpdateMessage(uxMessage, "User Permission Saved with Id " + userPermissionData.Id, 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);
        }

    }

Delete

Delete(System.Int64)

Deletes a user permission 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

• * User Permission ID

Parameters

• id. User or Group ID.

Remarks

Validate the item with GetItem() before deleting it.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUserPermissionIdLabel" AssociatedControlID="uxUserPermissionId"
            CssClass="span-4 last" runat="server" Text="*UserPermission Id:" />
        <ektronUI:TextField ID="uxUserPermissionId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxStatus" Visible="false" CssClass="span-9 last" runat="server"
            Text="Status:" />
    </li>
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Delete"></ektronUI:Button>
    <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</ol>
      
<ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" 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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Settings;
using Ektron.Cms.Framework.User;
using Microsoft.VisualBasic;
using Ektron.Cms.Framework.Content;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            PermissionManager permissionManager = new PermissionManager();
            UserPermissionData userPermissionData = new UserPermissionData();
            long UserPermissionId = long.Parse(uxUserPermissionId.Text);
            userPermissionData = permissionManager.GetItem(UserPermissionId);
            if (userPermissionData != null)
            {
                permissionManager.Delete(UserPermissionId);
                MessageUtilities.UpdateMessage(uxMessage, "UserPermission with Id " + UserPermissionId + " has been deleted from the CMS.", Message.DisplayModes.Success);
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid User Permission ID", Message.DisplayModes.Error);
                return;
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

DeletePermissionForGroup

DeletePermissionForGroup(Ektron.Cms.Settings.ItemType,
System.Int64,System.Int64)

Deletes an object permission from the CMS based on type and group.

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

• * Group ID
• * Item Type
• * Item ID

Parameters

• type. Type of the object to delete associated permission.
• groupId. ID of the group to which delete associated permissions.
• objectId. ID of the object to delete permissions.

Remarks

Validate the item with GetItem() before deleting it.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxgroupIDLabel" AssociatedControlID="uxgroupID"
            CssClass="span-4 last" runat="server" Text="*Group Id:" />
        <ektronUI:TextField ID="uxgroupID" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxItemTypeLabel" AssociatedControlID="uxItemType"
            CssClass="span-4 last" runat="server" Text="*ItemType :" />
        <asp:DropDownList ID="uxItemType" runat="server" CssClass="span-4">
            <asp:ListItem>Folder</asp:ListItem>                          
            <asp:ListItem>Content</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxItemIdLabel" AssociatedControlID="uxItemId"
            CssClass="span-4 last" runat="server" Text="*Item Id:" />
        <ektronUI:TextField ID="uxItemId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix" style="color: red;">
        <ektronUI:Label ID="uxStatus" Visible="false" CssClass="span-9 last" runat="server"
            Text="Status:" />
    </li>
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Delete"></ektronUI:Button>
    <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</ol>
           
<ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" 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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Settings;
using Ektron.Cms.Framework.User;
using Microsoft.VisualBasic;
using Ektron.Cms.Framework.Content;
using Ektron.Cms.Framework.Organization;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            PermissionManager permissionManager = new PermissionManager();
            long groupID = long.Parse(uxgroupID.Text);
            long itemId = long.Parse(uxItemId.Text);
            string itemType = uxItemType.SelectedItem.Text;

            UserGroupManager userGroupManager = new UserGroupManager();
            //Check Entered GroupID is Valid or Not
            UserGroupData userGroupData = userGroupManager.GetItem(groupID);
            if (userGroupData != null && userGroupData.Id > 0)
            {
                if (itemType == "Folder")
                {
                    FolderManager folderManager = new FolderManager();
                    FolderData folderData = folderManager.GetItem(itemId, false);
                    //Check Entered FolderId is Valid or Not
                    if (folderData != null)
                    {
                        permissionManager.DeletePermissionForGroup(Ektron.Cms.Settings.ItemType.Folder, groupID, itemId);
                    }
                    else
                    {
                        uxStatus.Visible = true;
                        MessageUtilities.UpdateMessage(uxStatus,  "Please Enter Valid Folder ID.", Message.DisplayModes.Error);
                        return;
                    }
                }
                else
                {
                    ContentManager contentManager = new ContentManager();
                    ContentData cData = contentManager.GetItem(itemId, false);
                    //Check Entered ContentID is Valid or Not
                    if (cData != null && cData.Id > 0)
                    {
                        permissionManager.DeletePermissionForGroup(Ektron.Cms.Settings.ItemType.Content, groupID, itemId);
                    }
                    else
                    {
                        uxStatus.Visible = true;
                        MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid Content ID.", Message.DisplayModes.Error);
                        return;
                    }
                }

            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid User ID.", Message.DisplayModes.Error);
                return;
            }
           
            MessageUtilities.UpdateMessage(uxMessage, "Permissions for an Object has been Deleted.", Message.DisplayModes.Success);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

DeletePermissionsForUser

DeletePermissionsForUser(Ektron.Cms.Settings.ItemType,System.Int64,System.Int64)

Deletes an object permission from the CMS based on type and 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

• * User ID
• * Item Type
• * Item ID

Parameters

• type. Type of the object to delete associated permission.
• userId. User ID of the user to which delete associated permissions.
• objectId. ID of the object to delete permissions.

Remarks

Validate the item with GetItem() before deleting it.

.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-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxItemTypeLabel" AssociatedControlID="uxItemType"
            CssClass="span-4 last" runat="server" Text="*ItemType :" />
        <asp:DropDownList ID="uxItemType" runat="server" CssClass="span-4">
            <asp:ListItem>Folder</asp:ListItem>                          
            <asp:ListItem>Content</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxItemIdLabel" AssociatedControlID="uxItemId"
            CssClass="span-4 last" runat="server" Text="*Item Id:" />
        <ektronUI:TextField ID="uxItemId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix" style="color: red;">
        <ektronUI:Label ID="uxStatus" Visible="false" CssClass="span-9 last" runat="server"
            Text="Status:" />
    </li>
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Delete"></ektronUI:Button>
    <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</ol>
           
<ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" 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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Settings;
using Ektron.Cms.Framework.User;
using Microsoft.VisualBasic;
using Ektron.Cms.Framework.Content;
using Ektron.Cms.Framework.Organization;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            PermissionManager permissionManager = new PermissionManager();
            long userID = long.Parse(uxUserId.Text);
            long itemId = long.Parse(uxItemId.Text);
            string itemType = uxItemType.SelectedItem.Text;

            UserManager Usermanager = new UserManager();         
            //Check Entered UserID is Valid or Not
            UserData Userdata = Usermanager.GetItem(userID);
            if (Userdata != null && Userdata.Id > 0)
            {
                if (itemType == "Folder")
                {
                    FolderManager folderManager = new FolderManager();
                    FolderData folderData = folderManager.GetItem(itemId, false);
                    //Check Entered FolderId is Valid or Not
                    if (folderData != null)
                    {
                        permissionManager.DeletePermissionsForUser(Ektron.Cms.Settings.ItemType.Folder, userID, itemId);
                    }
                    else
                    {
                        uxStatus.Visible = true;
                        MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid Folder ID.", Message.DisplayModes.Error);
                        return;
                    }
                }
                else
                {
                    ContentManager contentManager = new ContentManager();
                    ContentData cData = contentManager.GetItem(itemId, false);
                    //Check Entered ContentID is Valid or Not
                    if (cData != null && cData.Id > 0)
                    {
                        permissionManager.DeletePermissionsForUser(Ektron.Cms.Settings.ItemType.Content, userID, itemId);
                    }
                    else
                    {
                        uxStatus.Visible = true;
                        MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid Content ID.", Message.DisplayModes.Error);
                        return;
                    }
                }

            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid User ID.", Message.DisplayModes.Error);
                return;
            }
            
            MessageUtilities.UpdateMessage(uxMessage, "Permissions for an Object has been Deleted.", Message.DisplayModes.Success);

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

GetItem

GetItem(Ektron.Cms.UserPermissionData)

Retrieves the properties of a specific UserPermissionData 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 Permission ID

Parameters

• id. ID of the UserPermission to get.

Returns

UserPermission details in a UserPermissionData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUserPermissionIdLabel" AssociatedControlID="uxUserPermissionId"
            CssClass="span-4 last" runat="server" Text="*UserPermission Id:" />
        <ektronUI:TextField ID="uxUserPermissionId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxStatus" Visible="false" CssClass="span-9 last" runat="server"
            Text="Status:" />
    </li>
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetItem"></ektronUI:Button>
    <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</ol>
      
<ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxUserID" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxContentId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxIsInherited" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxIsPrivateContent" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxIsReadOnly" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxCanEdit" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxCanAdd" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxCanDelete" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxIsReadOnlyLib" 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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Settings;
using Ektron.Cms.Framework.User;
using Microsoft.VisualBasic;
using Ektron.Cms.Framework.Content;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            PermissionManager permissionManager = new PermissionManager();
            UserPermissionData userPermissionData = new UserPermissionData();
            userPermissionData = permissionManager.GetItem(long.Parse(uxUserPermissionId.Text));
            if (userPermissionData != null)
            {
                //Display the userPermission Details
                MessageUtilities.UpdateMessage(uxMessage, "UserPermission with Id " + userPermissionData.Id + " details are below:", Message.DisplayModes.Success);

                uxUserID.Text = "UserId : " + userPermissionData.UserId;
                uxContentId.Text = "Content Id : " + userPermissionData.ContentId;
                uxIsInherited.Text = "IsInherited : " + userPermissionData.IsInherited;
                uxIsPrivateContent.Text = "IsPrivateContent : " + userPermissionData.IsPrivateContent;
                uxIsReadOnly.Text = "IsReadOnly : " + userPermissionData.IsReadOnly;
                uxCanEdit.Text = "CanEdit : " + userPermissionData.CanEdit;
                uxCanAdd.Text = "CanAdd : " + userPermissionData.CanAdd;
                uxCanDelete.Text = "CanDelete : " + userPermissionData.IsPrivateContent;
                uxIsReadOnlyLib.Text = "IsReadOnlyLib : " + userPermissionData.IsReadOnlyLib;
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid User Permission ID", Message.DisplayModes.Error);
                return;
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetList

GetList(Ektron.Cms.Settings.PermissionCriteria)

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

• User Permission Property
• * Object Value

Parameters

• criteria. PermissionCriteria used to specify or filter the UserPermissionData object to return.

Returns

Returns a list of UserPermissions.

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="uxUserPermissionPropertyLabel" AssociatedControlID="uxUserPermissionProperty"
            CssClass="span-6 last" runat="server" Text="UserPermission Property :" />
        <asp:DropDownList ID="uxUserPermissionProperty" runat="server">
            <asp:ListItem>UserId</asp:ListItem>
            <asp:ListItem>Id</asp:ListItem>
            <asp:ListItem>ContentId</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-6 last"
            runat="server" Text="ObjectValue :" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="1" />
    </li>
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetList"></ektronUI:Button>
    <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</ol>
      
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
<asp:ListView ID="uxUserPermissionListView" runat="server" ItemPlaceholderID="aspItemPlaceholder"
    Visible="false">
    <EmptyDataTemplate>
        Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Id
                    </th>
                    <th>
                        UserId
                    </th>
                    <th>
                        FolderId
                    </th>
                    <th>
                        ContentId
                    </th>
                    <th>
                        IsInherited
                    </th>
                    <th>
                        IsReadOnly
                    </th>
                    <th>
                        IsReadOnlyLib
                    </th>
                    <th>
                        IsPrivateContent
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("Id")%>
            </td>
            <td class="devsite-method">
                <%# Eval("UserId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("FolderId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("ContentId ")%>
            </td>
            <td class="devsite-method">
                <%# Eval("IsInherited")%>
            </td>
            <td class="devsite-method">
                <%# Eval("IsReadOnly")%>
            </td>
            <td class="devsite-method">
                <%# Eval("IsReadOnlyLib")%>
            </td>
            <td class="devsite-method">
                <%# Eval("IsPrivateContent")%>
            </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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Settings;
using Ektron.Cms.Framework.User;
using Microsoft.VisualBasic;
using Ektron.Cms.Framework.Content;
using Ektron.Cms.Settings;
using Ektron.Cms.Common;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            PermissionManager permissionManager = new PermissionManager();
            object Objectvalue;
            string Property = uxUserPermissionProperty.SelectedItem.Text;
            Objectvalue = Convert.ToInt64(uxObjectValue.Text);

            PermissionCriteria criteria = new PermissionCriteria();
            criteria.OrderByDirection = EkEnumeration.OrderByDirection.Ascending;
            criteria.OrderByField = PermissionProperty.Id;

            if (Property == "Id")
            {
                criteria.AddFilter(PermissionProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (Property == "UserId")
            {
                criteria.AddFilter(PermissionProperty.UserId, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                criteria.AddFilter(PermissionProperty.ContentId, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            List<UserPermissionData> UserPermissionList = permissionManager.GetList(criteria);
            uxUserPermissionListView.Visible = true;
            uxUserPermissionListView.DataSource = UserPermissionList;
            uxUserPermissionListView.DataBind();

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

Update

Update(Ektron.Cms.UserPermissionData)

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

• * User Permission ID
• Content ID
• User ID
• Is Membership User
• Is Inherited
• Is Private Content
• Is Read Only
• Can Edit
• Can Add
• Can Delete
• Is Read Only Lib

Parameters

• permissionData

Returns

Returns the UserPermissionData object that was updated.

Remarks

Validate the User Permission Data item with GetItem() before you update the properties. Then, call Update with your modified UserPermissionData object.

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

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUserPermissionIdLabel" AssociatedControlID="uxUserPermissionId"
            CssClass="span-4 last" runat="server" Text="*UserPermission Id:" />
        <ektronUI:TextField ID="uxUserPermissionId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxContentIdLabel" AssociatedControlID="uxContentId" CssClass="span-4 last"
            runat="server" Text="Content Id:" />
        <ektronUI:TextField ID="uxContentId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-4 last"
            runat="server" Text="User Id:" />
        <ektronUI:TextField ID="uxUserId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIsMembershipUserLabel" AssociatedControlID="uxIsMembershipUser"
            CssClass="span-4 last" runat="server" Text="IsMembershipUser :" />
        <asp:DropDownList ID="uxIsMembershipUser" runat="server" CssClass="span-4 last">
            <asp:ListItem>True</asp:ListItem>
            <asp:ListItem>False</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIsInheritedLabel" AssociatedControlID="uxIsInherited" CssClass="span-4 last"
            runat="server" Text="IsInherited :" />
        <asp:DropDownList ID="uxIsInherited" runat="server" CssClass="span-4 last">
            <asp:ListItem>False</asp:ListItem>
            <asp:ListItem>True</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIsPrivateContentLabel" AssociatedControlID="uxIsPrivateContent"
            CssClass="span-4 last" runat="server" Text="IsPrivateContent :" />
        <asp:DropDownList ID="uxIsPrivateContent" runat="server" CssClass="span-4 last">
            <asp:ListItem>False</asp:ListItem>
            <asp:ListItem>True</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIsReadOnlyLabel" AssociatedControlID="uxIsReadOnly" CssClass="span-4 last"
            runat="server" Text="IsReadOnly :" />
        <asp:DropDownList ID="uxIsReadOnly" runat="server" CssClass="span-4 last">
            <asp:ListItem>True</asp:ListItem>
            <asp:ListItem>False</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCanEditLabel" AssociatedControlID="uxCanEdit" CssClass="span-4 last"
            runat="server" Text="CanEdit :" />
        <asp:DropDownList ID="uxCanEdit" runat="server" CssClass="span-4 last">
            <asp:ListItem>True</asp:ListItem>
            <asp:ListItem>False</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCanAddLabel" AssociatedControlID="uxCanAdd" CssClass="span-4 last"
            runat="server" Text="CanAdd :" />
        <asp:DropDownList ID="uxCanAdd" runat="server" CssClass="span-4 last">
            <asp:ListItem>True</asp:ListItem>
            <asp:ListItem>False</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxCanDeleteLabel" AssociatedControlID="uxCanDelete" CssClass="span-4 last"
            runat="server" Text="CanDelete :" />
        <asp:DropDownList ID="uxCanDelete" runat="server" CssClass="span-4 last">
            <asp:ListItem>True</asp:ListItem>
            <asp:ListItem>False</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIsReadOnlyLibLabel" AssociatedControlID="uxIsReadOnlyLib" CssClass="span-4 last"
            runat="server" Text="IsReadOnlyLib :" />
        <asp:DropDownList ID="uxIsReadOnlyLib" runat="server" CssClass="span-4 last">
            <asp:ListItem>True</asp:ListItem>
            <asp:ListItem>False</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxStatus" Visible="false" CssClass="span-9 last" runat="server"
            Text="Status:" />
    </li>
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Update"></ektronUI:Button>
    <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</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.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Settings;
using Ektron.Cms.Framework.User;
using Microsoft.VisualBasic;
using Ektron.Cms.Framework.Content;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            userPermissionData = permissionManager.GetItem(long.Parse(uxUserPermissionId.Text));
            if (userPermissionData != null)
            {
                UserManager Usermanager = new UserManager();
                UserId = long.Parse(uxUserId.Text);
                if (UserId > 0)
                {
                    //Check whether entered UserID is Valid or Not
                    UserData Userdata = Usermanager.GetItem(UserId);
                    if (Userdata != null && Userdata.IsDeleted == false)
                    {
                        userPermissionData.UserId = UserId;
                        update();
                    }
                    else
                    {
                        uxStatus.Visible = true;
                        MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid User ID", Message.DisplayModes.Error);
                        return;
                    }
                }
                else
                {
                    update();
                }
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid User Permission ID", Message.DisplayModes.Error);
                return;
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

PermissionCriteria

Namespace

Ektron.Cms.Settings

Constructors

• PermissionCriteria()

  public PermissionCriteria()

• PermissionCriteria(Ektron.Cms.Settings.PermissionProperty, EkEnumeration.OrderByDirection)

  public PermissionCriteria(Ektron.Cms.Settings.PermissionProperty
    orderByField, EkEnumeration.OrderByDirection orderByDirection)

  Accepted fields for the PermissionProperty are:

  • CanAdd
  • CanDelete
  • CanEdit
  • ContentId
  • FolderId
  • Id
  • IsReadOnly
  • LanguageId
  • UserGroupId
  • UserId

UserPermissionData

Namespace

Ektron.Cms

Properties

• ContentId

  public long ContentId { set; get; }

• DisplayGroupName

  public string DisplayGroupName { set; get; }

• DisplayUserName

  public string DisplayUserName { set; get; }

• Domain

  public string Domain { set; get; }

• FolderId

  public long FolderId { set; get; }

• GroupDomain

  public string GroupDomain { set; get; }

• GroupId

  public long GroupId { set; get; }

• GroupName

  public string GroupName { set; get; }

• InheritedFrom

  public long InheritedFrom { set; get; }

• IsInherited

  public bool IsInherited { set; get; }

• IsMembershipUser

  public bool IsMembershipUser { set; get; }

• IsPrivateContent

  public bool IsPrivateContent { set; get; }

• UserId

  public long UserId { set; get; }

• UserName

  public string UserName { set; get; }

• Validate()

  public override
    Microsoft.Practices.EnterpriseLibrary.Validation.ValidationResults
    Validate()