UserManager

ActivateUserAccount (account ID)

ActivateUserAccount(System.String,System.String)

Activates a deactivated user into the current or active state using the username and account ID.

Background Information

Ektron supports 2 types of users:

• CMS users (licensed authors)
• Membership users (site members)

You can configure Ektron so that self-registering membership users must be validated by a site manager/moderator before they can use their account. ActivateUserAccount verifies and activates a membership account.

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 Name
• * Account ID

Parameters

• userName. The user name login for the user.
• accountId. The account ID for the user.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronui:label id="uxUserNameLabel" associatedcontrolid="uxUserName" cssclass="span-3 last"
            runat="server" text="*User Name:" />
        <ektronui:textfield id="uxUserName" cssclass="span-6" runat="server" validationgroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronui:label id="uxAccountIdLabel" associatedcontrolid="uxAccountId" cssclass="span-3 last"
            runat="server" text="*Account Id:" />
        <ektronui:textfield id="uxAccountId" 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="Activate"></ektronui:button>
    </li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using Ektron.Cms;
using Ektron.Cms.Framework.UI.Controls.EktronUI;
using Ektron.Cms.Framework.User;
using Ektron.Site.Developer;

.aspx.cs code-behind method

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

            UserData userData = userManager.GetItem(userId);
            if (userData != null)
            {
                if (!userData.IsDeleted)
                {
                    MessageUtilities.UpdateMessage(uxMessage, " The User Id " + userId + " has been activated. ", Message.DisplayModes.Success);
                }
                else
                {
                    uxStatus.Visible = true;
                    MessageUtilities.UpdateMessage(uxStatus, " The User Id is not activated. ", Message.DisplayModes.Error);
                    return;
                }
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please enter a Valid User Id.", Message.DisplayModes.Error);
                return;
            }
            
        uxPageMultiView.SetActiveView(uxViewMessage);
    }
    catch (Exception ex)
    {
        MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
        uxPageMultiView.SetActiveView(uxViewMessage);
    }

    }

ActivateUserAccount (user)

ActivateUserAccount(System.String,System.String)

Activates a deactivated user into the current or active state using the user ID.

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 Name

Parameters

• userId. A unique ID to activate.

.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"
            text="0" />
    </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="Activate"></ektronui:button>
    </li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using Ektron.Cms;
using Ektron.Cms.Framework.UI.Controls.EktronUI;
using Ektron.Cms.Framework.User;
using Ektron.Site.Developer;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            UserManager userManager = new UserManager();
            String userName = uxUserName.Text;
            String accountId = uxAccountId.Text;
           
            userManager.ActivateUserAccount(userName, accountId);

            Ektron.Cms.User.UserCriteria userCriteria = new Ektron.Cms.User.UserCriteria();
            userCriteria.AddFilter(Ektron.Cms.User.UserProperty.UserName, Ektron.Cms.Common.CriteriaFilterOperator.EqualTo, userName);

            List<UserData> userDataList = userManager.GetList(userCriteria);

            foreach (UserData userData in userDataList)
            {

                if (userData != null)
                {
                    if (!userData.IsDeleted)
                    {
                        MessageUtilities.UpdateMessage(uxMessage, " The User Name " + userName + " has been activated. ", Message.DisplayModes.Success);
                    }
                    else
                    {
                        uxStatus.Visible = true;
                        MessageUtilities.UpdateMessage(uxStatus, " The User Name is not activated ", Message.DisplayModes.Error);
                        return;
                    }
                }
                else
                {
                    uxStatus.Visible = true;
                    MessageUtilities.UpdateMessage(uxStatus, "Please enter a Valid User Name and Account Id.", Message.DisplayModes.Error);
                    return;
                }
            }
            
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

ActivateUserAccounts (user ID)

ActivateUserAccounts(System.Collections.Generic.List)

Activates the deactivated users into the current or active state using the user IDs.

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 Name
• * Account ID

Parameters

• userIds. The list of user IDs to activate.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronui:label id="uxUserIdsLabel" associatedcontrolid="uxUserIds" cssclass="span-5 last"
            runat="server" text="*User Ids (Comma Seperated):" />
        <ektronui:textfield id="uxUserIds" cssclass="span-6" 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>
    <li class="clearfix">
        <ektronui:button id="uxSubmit" runat="server" onclick="uxSubmit_Click" text="Activate"></ektronui:button>
    </li>
</ol>
<asp:literal id="uxMessage" runat="server"></asp:literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using Ektron.Cms.Framework.UI.Controls.EktronUI;
using Ektron.Cms.Framework.User;
using Ektron.Site.Developer;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            UserManager userManager = new UserManager();
            string ids = uxUserIds.Text;
            string[] userIds = ids.Split(new char[] { ',' }, StringSplitOptions.RemoveEmptyEntries);
            if (userIds.Length > 0)
            {
                List<long> userIdList = new List<long>();
                foreach (string userId in userIds)
                {
                    userIdList.Add(long.Parse(userId));
                }
                userManager.ActivateUserAccounts(userIdList);
                MessageUtilities.UpdateMessage(uxMessage, " The User Ids " + ids + " has been activated. ", Message.DisplayModes.Success);
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please enter a User Id.", Message.DisplayModes.Error);
                return;
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

Add

Add(Ektron.Cms.UserData)

Adds a user with details from the supplied UserData 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 Name
• * Password
• * First Name
• * Last Name
• * Display
• Email

Parameters

• userData. The UserData object to add to the CMS.

Returns

Returns the custom CmsData object added.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUserNameLabel" AssociatedControlID="uxUserName" CssClass="span-3 last"
            runat="server" Text="*UserName :" />
        <ektronUI:TextField ID="uxUserName" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxPasswordLabel" AssociatedControlID="uxPassword" CssClass="span-3 last"
            runat="server" Text="*Password :" />
        <asp:TextBox ID="uxPassword" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            TextMode="Password" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxFirstNameLabel" AssociatedControlID="uxFirstName" CssClass="span-3 last"
            runat="server" Text="*FirstName :" />
        <ektronUI:TextField ID="uxFirstName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxLastNameLabel" AssociatedControlID="uxLastName" CssClass="span-3 last"
            runat="server" Text="*LastName :" />
        <ektronUI:TextField ID="uxLastName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxDisplayLabel" AssociatedControlID="uxDisplay" CssClass="span-3 last"
            runat="server" Text="*Display :" />
        <ektronUI:TextField ID="uxDisplay" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxEmailLabel" AssociatedControlID="uxEmail" CssClass="span-3 last"
            runat="server" Text="Email :" />
        <ektronUI:TextField ID="uxEmail" 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>
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Save"></ektronUI:Button>
</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.User;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            UserManager userManager = new UserManager();
            //Check the Valid EmailAddress or Not
            string emailAddress = uxEmail.Text;
            if (!string.IsNullOrEmpty(emailAddress))
            {
                try
                {
                    System.Net.Mail.MailAddress addr = new System.Net.Mail.MailAddress(emailAddress);
                }
                catch 
                {
                    uxStatus.Visible = true;
                    MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid Email Address.", Message.DisplayModes.Error);
                    return;
                }
            }

            //long TIME_ZONE = 240;
            //long PHONE = 242;

            //Set the User Details
            UserData userData = new UserData()
            {
                Username = uxUserName.Text,
                Password = uxPassword.Text,
                FirstName = uxFirstName.Text,
                LastName = uxLastName.Text,
                DisplayName = uxDisplay.Text,
                Email = emailAddress,
                IsMemberShip = true
            };

            userData.CustomProperties = userManager.GetCustomPropertyList();
            userData.CustomProperties["Phone"].Value = "603-555-9999";
            userData.CustomProperties["Time Zone"].Value = "Eastern Standard Time";
            //userData.AttributeList = new CustomAttribute[2];
            //userData.AttributeList[0] = new CustomAttribute() { ID = "242", Value = "603-555-1212" };
            //userData.AttributeList[1] = new CustomAttribute() { ID = "240", Value = "Hawaiian Standard Time" };
     
            //Add a New User with User Details
            userManager.Add(userData);
            MessageUtilities.UpdateMessage(uxMessage, "User Saved with Id " + userData.Id, Message.DisplayModes.Success);

            uxPageMultiView.SetActiveView(uxViewMessage);

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

    }

AssignTaxonomy

AssignTaxonomy(System.Int64,System.Int64)

Assigns a user taxonomy to a category.

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
• * Taxonomy ID

Parameters

• userId. ID of the user.
• categoryId. ID of the category.

.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" Text="0" />
 
    </li>
        <li class="clearfix">
        <ektronUI:Label ID="uxTaxonomyIDLabel" AssociatedControlID="uxTaxonomyID" CssClass="span-3 last" runat="server" Text="Taxonomy Id:" />
        <ektronUI:TextField ID="uxTaxonomyID" CssClass="span-6" 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="Save"></ektronUI:Button>
</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.User;
using Ektron.Cms.Framework.Organization;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            UserManager Usermanager = new UserManager();
            long UserId = long.Parse(uxUserId.Text);
            long TaxonomyID = long.Parse(uxTaxonomyID.Text);

            //Get the User data to check Valid UserId or Not
            UserData Userdata = Usermanager.GetItem(UserId);
            if (Userdata != null)
            {
                TaxonomyManager taxonomyManager = new TaxonomyManager();
                TaxonomyData taxonomyData = taxonomyManager.GetItem(TaxonomyID);

                if (taxonomyData != null)
                {
                    //Assign User Taxonomy to a Category 
                    Usermanager.AssignTaxonomy(UserId, TaxonomyID);
                    MessageUtilities.UpdateMessage(uxMessage,  " User Id : " + UserId + " has been Assigned to Taxonomy ID : " + TaxonomyID, Message.DisplayModes.Success);
                }
                else
                {
                    uxStatus.Visible = true;
                    MessageUtilities.UpdateMessage(uxStatus, "Please enter a Valid Taxonomy ID.", Message.DisplayModes.Error);
                    return;
                }
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please enter a Valid User ID.", Message.DisplayModes.Error);
                return;
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

Authenticate

Authenticate a user:

Authenticate(System.String,System.String)

Authenticate a user in a specific domain:

Authenticate(System.String,System.String,System.String)

Retrieves an authentication token that you can use to authenticate the user in a particular domain. WCF headers pass the authentication token to the application tier.

NOTE: Authenticate is used only in 3-Tier deployments.

In 2-Tier deplolyments, if you need to run an API using elevated permissions, you can initialize the API to put it into "Internal Admin" mode.

var UserCRUD = new UserManager(Ektron.Cms.Framework.ApiAccessMode.Admin);

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 Name
• * Password
• Domain (Optional for user in a specific domain)

Parameters

• userName. The user name of user to validate.
• password. The user's password.
• domain. Optional: The domain to validate.

Returns

An authentication token. If authentication fails, an empty string is returned.

NOTE: Authenticate does not log the user into the CMS. Use the Login (user) method to log in a user.

.aspx code snippet

<asp:Panel ID="uxAuthenticateForm" runat="server" DefaultButton="uxAuthenticate">
    <p>
        * indicates a required field.
    </p>
    <p>
        * Username:
        <asp:TextBox ID="uxUsername" runat="server" />
    </p>
    <p>
        * Password:
        <asp:TextBox ID="uxPassword" runat="server" TextMode="Password" />
    </p>
    <p>
        Domain:
        <asp:TextBox ID="uxDomain" runat="server" />
    </p>
    <p>
        <asp:Button ID="uxAuthenticate" runat="server" Text="Authenticate" OnClick="uxAuthenticate_Click" />
    </p>
</asp:Panel>
<asp:Panel ID="uxAuthenticateFail" runat="server" Visible="false">
    Authentication failed for the supplied username, password, and domain.
</asp:Panel>
<asp:Panel ID="uxAuthenticateSuccess" runat="server" Visible="false">
    Your Authentication Token is: <asp:Literal ID="uxToken" runat="server" />
</asp:Panel>

.aspx.cs code-behind method

protected void uxAuthenticate_Click(object sender, EventArgs e)
{
    uxAuthenticateForm.Visible = false;
    var UserCRUD = new Ektron.Cms.Framework.User.UserManager();
    string Token = UserCRUD.Authenticate(uxUsername.Text, uxPassword.Text, uxDomain.Text);
    if (!string.IsNullOrEmpty(Token)) // Success
    {
        uxAuthenticateSuccess.Visible = true;
        uxToken.Text = Token;
    }
    else // Fail
    {
        uxAuthenticateFail.Visible = true;
    }
}

Sample Token Use

private void UpdateContent(Ektron.Cms.ContentData ContentToUpdate, string AuthenticationToken)
{
    var ContentCRUD = new Ektron.Cms.Framework.Content.ContentManager();
    if (!string.IsNullOrEmpty(AuthenticationToken))
    {
        string originalToken = ContentCRUD.RequestInformation.AuthenticationToken;
        try
        {
            ContentCRUD.RequestInformation.AuthenticationToken = AuthenticationToken;
            ContentCRUD.Update(ContentToUpdate);
        }
        catch (Exception ex)
        {
            Ektron.Cms.EkException.LogException(ex);
        }
        finally
        {
            ContentCRUD.RequestInformation.AuthenticationToken = originalToken;
        }
    }
}

CanViewUserProfile

CanViewUserProfile(System.Int64,System.Int64)

Returns true if the viewer (viewerId) can view the other users profile (userid).

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
• * Viewer ID

Parameters

• userId. ID of user's profile to view.
• viewerId. ID of user trying to view profile.

.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"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxViewerIdLabel" AssociatedControlID="uxViewerId" CssClass="span-3 last"
            runat="server" Text="*Viewer Id:" />
        <ektronUI:TextField ID="uxViewerId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
        <div class="ektronTopSpace"></div>
    <li class="clearfix">
        <ektronUI:Message ID="uxStatus" DisplayMode="Error" runat="server" Visible="false" />
    </li>
        <div class="ektronTopSpace"></div>
        <li class="clearfix"> 
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="CanView"></ektronUI:Button>
    <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" /></li>
</ol>
      
<ektronUI:Message ID="uxMessage" DisplayMode="Information" Visible="false" runat="server" />

.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.User;
using Ektron.Cms.Framework.Organization;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            UserManager Usermanager = new UserManager();
            long UserId = long.Parse(uxUserId.Text);
            long ViewerId = long.Parse(uxViewerId.Text);
            bool status = false;
            //Get the User data to check Valid UserId or Not
            UserData Userdata = Usermanager.GetItem(UserId);
            if (Userdata != null)
            {
                //Get the Viewer data to check Valid ViewerId or Not
                UserData viewerdata = Usermanager.GetItem(ViewerId);

                if (viewerdata != null)
                {
                    status = Usermanager.CanViewUsersProfile(UserId, ViewerId);
                    if (status)
                        MessageUtilities.UpdateMessage(uxMessage, " Viewer Id : " + ViewerId + " can view the user Id : " + UserId + " profile.", Message.DisplayModes.Success);
                    else
                        MessageUtilities.UpdateMessage(uxMessage, " Viewer Id : " + ViewerId + " Cannot view the user Id : " + UserId + " profile.", Message.DisplayModes.Success);
                }
                else
                {
                    uxStatus.Visible = true;
                    MessageUtilities.UpdateMessage(uxStatus, "Please enter a Valid Viewer ID.", Message.DisplayModes.Error);
                    return;
                }
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please enter a Valid User 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 user (using the UserData 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

• * User ID

Parameters

• id. ID of the user to delete.

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-3 last" runat="server" Text="User Id:" />
        <ektronUI:TextField ID="uxUserId" CssClass="span-6" 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>
</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.User;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            UserManager Usermanager = new UserManager();
            long UserId = long.Parse(uxUserId.Text);
            if (UserId > 0)
            {
                UserData userdata = Usermanager.GetItem(UserId);
                if (userdata != null)
                {
                    if (!userdata.IsDeleted)
                    {   //Delete the UserID
                        Usermanager.Delete(UserId);
                        MessageUtilities.UpdateMessage(uxMessage,  " User Id : " + UserId + " has been Deleted from CMS ", Message.DisplayModes.Success);
                    }
                    else
                    {
                        uxStatus.Visible = true;
                        MessageUtilities.UpdateMessage(uxStatus, "Entered User ID is already deleted.", Message.DisplayModes.Error);
                        return;
                    }
                }
                else
                {
                    uxStatus.Visible = true;
                    MessageUtilities.UpdateMessage(uxStatus, "Please enter a Valid User ID.", Message.DisplayModes.Error);
                    return;
                }
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please enter a Valid User ID.", Message.DisplayModes.Error);
                return;
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

GetItem (authentication)

GetItem(System.Int64,System.String)

Retrieves details of a user, based on an authentication type and authentication user ID.

Authentication Types represent third-party integrations for authenticating users. For example, AuthenticationTypeId = 1 is Facebook integration and the authenticationUserId in this case would be the users Facebook ID. So GetItem(1, '1111111111') would return the CMS user who logs in through Facebook and has the Facebook ID '1111111111'.

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

• * Authentication Type ID
• Authentication User ID

Parameters

• authenticationTypeId. ID of authentication type user is associated with.
• authenticationUserId. ID of user based on authentication type.

Returns

User details in a UserData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxAuthenticationTypeIDLabel" AssociatedControlID="uxAuthenticationTypeID" CssClass="span-4 last"
            runat="server" Text="AuthenticationType ID:" />
        <ektronUI:TextField ID="uxAuthenticationTypeID" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
        <li class="clearfix">
        <ektronUI:Label ID="uxAuthenticationUserIDLabel" AssociatedControlID="uxAuthenticationUserID" CssClass="span-4 last"
            runat="server" Text="AuthenticationUser ID:" />
        <ektronUI:TextField ID="uxAuthenticationUserID" CssClass="span-6" 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="GetDetails"></ektronUI:Button>
</ol>
      
<ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxUserName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxFirstName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxLastName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxDisplayName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxEmail" 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.User;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            UserManager Usermanager = new UserManager();
            long AuthenticationTypeID = long.Parse(uxAuthenticationTypeID.Text);
            //Get the User data for given ID
            UserData Userdata = Usermanager.GetItem(AuthenticationTypeID, uxAuthenticationUserID.Text);
            if (Userdata != null)
            {
                //Display  User Details
                MessageUtilities.UpdateMessage(uxMessage, "User Details for  User Id : " + Userdata.Id + " are below", Message.DisplayModes.Success);

                uxUserName.Text = "UserName : " + Userdata.Username;
                uxFirstName.Text = "FirstName : " + Userdata.FirstName;
                uxLastName.Text = "LastName : " + Userdata.LastName;
                uxDisplayName.Text = "DisplayName : " + Userdata.DisplayName;
                uxEmail.Text = "Email : " + Userdata.Email;
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid Authentication Values.", Message.DisplayModes.Error);
                return;
            }
            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 UserData 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

Parameters

• id

Returns

User details in a UserData object.

.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"
            Text="1" />
    </li>
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetDetails"></ektronUI:Button>
</ol>
         
<ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxUserName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxFirstName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxLastName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxDisplayName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxEmail" 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.User;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            UserManager Usermanager = new UserManager();
            long UserId = long.Parse(uxUserId.Text);
            //Get the User data for given UserID
            UserData Userdata = Usermanager.GetItem(UserId);
            if (Userdata != null)
            {
                //Display  User Details
                MessageUtilities.UpdateMessage(uxMessage, "User Details for  User Id : " + UserId + " are below", Message.DisplayModes.Success);
                uxUserName.Text = "UserName : " + Userdata.Username;
                uxFirstName.Text = "FirstName : " + Userdata.FirstName;
                uxLastName.Text = "LastName : " + Userdata.LastName;
                uxDisplayName.Text = "DisplayName : " + Userdata.DisplayName;
                uxEmail.Text = "Email : " + Userdata.Email;
                uxEmail.Text = "IsDeleted : " + Userdata.IsDeleted;
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid User ID and Try again.", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

GetItem (properties)

GetItem(System.Int64,System.Boolean)

Retrieves the properties of a specific UserData object, including any custom properties.

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
• * Include Custom Properties

Parameters

• id. ID of the user to get.

Returns

User details in a UserData object.

.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"
            Text="1" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxIncludeCustomLabel" AssociatedControlID="uxIncludeCustom" CssClass="span-3 last"
            runat="server" Text="*Include Custom Properties:" />
        <ektronUI:Button ID="uxIncludeCustom" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="" DisplayMode="Checkbox" Checked="True" />
    </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="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="uxUserName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxFirstName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxLastName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxDisplayName" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxEmail" runat="server"></asp:Literal>
    </li>
        <li class="clearfix">
        <asp:Literal ID="uxTime" runat="server"></asp:Literal>
    </li>
        <li class="clearfix">
        <asp:Literal ID="uxPhone" 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.User;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            UserManager Usermanager = new UserManager();
            long UserId = long.Parse(uxUserId.Text);
            bool include = false;
            if (uxIncludeCustom.Checked)
            {
                include = true;
            }

            //Get the User data for given UserID
            UserData Userdata = Usermanager.GetItem(UserId, include);
            if (Userdata != null)
            {
                //Display  User Details
                MessageUtilities.UpdateMessage(uxMessage, "User Details for  User Id : " + UserId + " are below", Message.DisplayModes.Success);

                uxUserListView.DataSource = new UserData[]{Userdata};
                uxUserListView.DataBind();
            }
            else
            {
                uxStatus.Visible = true;
                MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid User ID.", Message.DisplayModes.Error);
                return;
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

GetList (property)

GetList(Ektron.Cms.User.UserCustomPropertyCriteria)

Retrieves lists of objects.

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 Custom Property Name
• * User Custom Property Value

Parameters

• criteria. UserCustomPropertyCriteria used to specify, or filter, the users to return.

Returns

A list of users.

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="uxUserCustomPropertyLabel" AssociatedControlID="uxUserCustomProperty"
            CssClass="span-6 last" runat="server" Text="*UserCustomProperty Name :" />
        <ektronUI:TextField ID="uxUserCustomProperty" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="Phone" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-6 last"
            runat="server" Text="*UserCustomProperty Value :" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="603" />
    </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="uxUserlistView" 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>
                        User Name
                    </th>
                    <th>
                        Display Name
                    </th>
                    <th>
                        Email
                    </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("UserName")%>
            </td>
            <td class="devsite-method">
                <%# Eval("DisplayName")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Email")%>
            </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.User;
using Ektron.Cms.Common;
using Ektron.Cms.User;

.aspx.cs code-behind method

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

            UserManager Usermanager = new UserManager();
            Ektron.Cms.User.UserCustomPropertyCriteria userCustomproperty = new UserCustomPropertyCriteria();
            object objectvalue= uxObjectValue.Text;
            userCustomproperty.AddFilter(uxUserCustomProperty.Text, CriteriaFilterOperator.Contains, objectvalue);

            List<UserData> UserList = Usermanager.GetList(userCustomproperty);

            uxUserlistView.Visible = true;
            uxUserlistView.DataSource = UserList;
            uxUserlistView.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);

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

    }

GetList (taxonomy)

GetList(Ektron.Cms.User.UserTaxonomyCriteria)

Retrieves lists of objects.

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 Property
• * Object Value

Parameters

• criteria. UserTaxonomyCriteria used to specify, or filter, the users to return.

Returns

A list of users.

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="uxUserPropertyLabel" AssociatedControlID="uxUserProperty" CssClass="span-3 last"
            runat="server" Text="UserProperty :" />
        <asp:DropDownList ID="uxUserProperty" runat="server">
            <asp:ListItem>Id</asp:ListItem>
            <asp:ListItem>Path</asp:ListItem>
        </asp:DropDownList>
    </li>   
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-3 last"
            runat="server" Text="*ObjectValue :" />
        <ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="1" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetList"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
    </li>
</ol>         
       
<asp:View ID="uxViewMessage" runat="server">
    <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
</asp:View>
    <asp:ListView ID="uxUserlist" 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>
                            User Name
                        </th>
                        <th>
                            Display Name
                        </th>
                        <th>
                            Email
                        </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("UserName")%>
                </td>
                <td class="devsite-method">
                    <%# Eval("DisplayName")%>
                </td>
                <td class="devsite-method">
                    <%# Eval("Email")%>
                </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.User; 
using Ektron.Cms.Common; 
using Ektron.Cms.User; 
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
        {
            object Objectvalue;
            string Property = uxUserProperty.SelectedItem.Text;

            UserManager Usermanager = new UserManager();
            UserTaxonomyCriteria criteria = new UserTaxonomyCriteria(UserProperty.Id, EkEnumeration.OrderByDirection.Ascending);
            if (Property == "Id")
            {
                Objectvalue = Convert.ToInt64(uxObjectValue.Text);
                criteria.AddFilter(UserTaxonomyProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(UserTaxonomyProperty.Path, CriteriaFilterOperator.EqualTo, Objectvalue);
            }

            List<UserData> UserList = Usermanager.GetList(criteria);

            uxUserlist.Visible = true;
            uxUserlist.DataSource = UserList;
            uxUserlist.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);

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

    }

GetList (user)

GetList(Ektron.Cms.User.UserCriteria)

Retrieves lists of objects.

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 Property
• * Object Value

Parameters

• criteria. UserCriteria used to specify, or filter, the users to return.

Returns

A list of users.

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="uxUserPropertyLabel" AssociatedControlID="uxUserProperty" CssClass="span-3 last"
            runat="server" Text="UserProperty :" />
        <asp:DropDownList ID="uxUserProperty" runat="server">
            <asp:ListItem>Id</asp:ListItem>
            <asp:ListItem>UserName</asp:ListItem>
            <asp:ListItem>DisplayName</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-3 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="uxUserlist" 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>
                        User Name
                    </th>
                    <th>
                        Display Name
                    </th>
                    <th>
                        Email
                    </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("UserName")%>
            </td>
            <td class="devsite-method">
                <%# Eval("DisplayName")%>
            </td>
            <td class="devsite-method">
                <%# Eval("Email")%>
            </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.User;
using Ektron.Cms.Common;
using Ektron.Cms.User;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            object Objectvalue;
            string Property = uxUserProperty.SelectedItem.Text;

            UserManager Usermanager = new UserManager();
            UserCriteria criteria = new UserCriteria(UserProperty.UserName, EkEnumeration.OrderByDirection.Ascending);
            if (Property == "Id")
            {
                Objectvalue = Convert.ToInt64(uxObjectValue.Text);
                criteria.AddFilter(UserProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else if (Property == "UserName")
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(UserProperty.UserName, CriteriaFilterOperator.EqualTo, Objectvalue);
            }
            else
            {
                Objectvalue = uxObjectValue.Text;
                criteria.AddFilter(UserProperty.DisplayName, CriteriaFilterOperator.EqualTo, Objectvalue);
            }

            List<UserData> UserList = Usermanager.GetList(criteria);

            uxUserlist.Visible = true;
            uxUserlist.DataSource = UserList;
            uxUserlist.DataBind();

            uxPageMultiView.SetActiveView(uxViewMessage);

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

    }

Login (automatic)

Login(System.Int64,System.String)

Automatically logs in a user based on an authentication type and authentication user ID.

NOTE: Prior to Ektron 9.40 SP1, this method required you to run setAuthenticationCookie (with name ecm...) after calling it. In Ektron 9.40 SP1, this is done for you.

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

• * Authentication Type ID
• * Authentication User ID

Parameters

• authenticationTypeId. ID of authentication type user is associated with.
• authenticationUserId. ID of user based on authentication type.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxStatusLabel" CssClass="span-6" runat="server" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxAuthenticationTypeIDLabel" AssociatedControlID="uxAuthenticationTypeID"
            CssClass="span-4 last" runat="server" Text="AuthenticationType ID:" />
        <ektronUI:TextField ID="uxAuthenticationTypeID" CssClass="span-6" runat="server"
            ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxAuthenticationUserIDLabel" AssociatedControlID="uxAuthenticationUserID"
            CssClass="span-4 last" runat="server" Text="AuthenticationUser ID:" />
        <ektronUI:TextField ID="uxAuthenticationUserID" CssClass="span-6" runat="server"
            ValidationGroup="RegisterValidationGroup" Text="0" />
    </li>
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Login"></ektronUI:Button>
</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.User;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {           
            UserManager Usermanager = new UserManager();
            if (!Ektron.Cms.Framework.Context.UserContextService.Current.IsLoggedIn)
            {
                UserData userdata = Usermanager.Login(uxUserName.Text, uxPassword.Text);               
                if (userdata != null)
                {
                    MessageUtilities.UpdateMessage(uxMessage,  " User : " + uxUserName.Text + " has successfully Logged In ", Message.DisplayModes.Success);
                    Response.Redirect(Request.UrlReferrer.AbsoluteUri);
                }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, " User : " + Usermanager.RequestInformation.LoggedInUsername + " is already  Logged In ", Message.DisplayModes.Success);
            }            
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            //error logging in
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

Login (user)

Login(System.String,System.String,System.String)

Logs in a user.

NOTE: Prior to Ektron 9.40 SP1, this method required you to run setAuthenticationCookie (with name ecm..) after calling it. In Ektron 9.40 SP1, this is done for you.

NOTE: In Ektron 8.6, this method was modified to generate an error if a user cannot successfully log in. (Previous to 8.6, Login returned an empty UserData object on unsuccessful login attempts, which left the developer unaware of what happened or why it happened.)

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

• * Username
• * Password

Parameters

• userName. User name of user to login.
• password. User's password.
• domain. Name of domain the user is logging in to. This parameter is only applicable for ADactive directory and LDAPLightweight Directory Access Protocol; permits access to distributed information. configurations.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxStatusLabel" CssClass="span-6" runat="server" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxUserNameLabel" AssociatedControlID="uxUserName" CssClass="span-3 last"
            runat="server" Text="UserName :" />
        <ektronUI:TextField ID="uxUserName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup"  />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxPasswordLabel" AssociatedControlID="uxPassword" CssClass="span-3 last"
            runat="server" Text="Password :" />
        <asp:TextBox ID="uxPassword" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            TextMode="Password"  />
    </li>
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Login"></ektronUI:Button>                    
</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.User;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            UserManager Usermanager = new UserManager();
            if (!Ektron.Cms.Framework.Context.UserContextService.Current.IsLoggedIn)
            {
                //Logs in, a user
                UserData userdata = Usermanager.Login(Convert.ToInt64(uxAuthenticationTypeID.Text), uxAuthenticationUserID.Text);

                if (userdata.Id > 0)
                {
                    MessageUtilities.UpdateMessage(uxMessage, " User : " + userdata.Username + " has successfully Logged In ", Message.DisplayModes.Success);
                    Response.Redirect(Request.UrlReferrer.AbsoluteUri);
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "The UserName or Password you entered is not correct", Message.DisplayModes.Error);
                }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, " User : " + Usermanager.RequestInformation.LoggedInUsername + " is already  Logged In ", Message.DisplayModes.Success);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

RemoveTaxonomy

RemoveTaxonomy(System.Int64,System.Int64)

Removes a user taxonomy from a category.

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
• * Taxonomy ID

Parameters

• userId. ID of the user.
• categoryId. ID of the category.

.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" Text="0" />
        </li>
            <li class="clearfix">
            <ektronUI:Label ID="uxTaxonomyIDLabel" AssociatedControlID="uxTaxonomyID" CssClass="span-3 last" runat="server" Text="Taxonomy Id:" />
            <ektronUI:TextField ID="uxTaxonomyID" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="0" />
        </li>
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Save"></ektronUI:Button>
    </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.User;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            UserManager Usermanager = new UserManager();
            long UserId = long.Parse(uxUserId.Text);
            long TaxonomyID = long.Parse(uxTaxonomyID.Text);
            //Remove User Taxonomy to a Category 
            Usermanager.RemoveTaxonomy(UserId, TaxonomyID);

            MessageUtilities.UpdateMessage(uxMessage, " User Id : " + UserId + " has been Removed from Taxonomy ID : " + TaxonomyID, Message.DisplayModes.Success);

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

    }

Update

Update(Ektron.Cms.UserData)

Updates an existing UserData object 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 ID
• User Name
• * Password
• First Name
• Last Name
• Display
• Email

Parameters

• userData. The UserData object to update in the CMS.

Returns

Returns the custom CmsData object updated.

Remarks

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

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

.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"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxUserNameLabel" AssociatedControlID="uxUserName" CssClass="span-3 last"
            runat="server" Text="UserName :" />
        <ektronUI:TextField ID="uxUserName" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxPasswordLabel" AssociatedControlID="uxPassword" CssClass="span-3 last"
            runat="server" Text="*Password :" />
        <asp:TextBox ID="uxPassword" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            TextMode="Password" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxFirstNameLabel" AssociatedControlID="uxFirstName" CssClass="span-3 last"
            runat="server" Text="FirstName :" />
        <ektronUI:TextField ID="uxFirstName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxLastNameLabel" AssociatedControlID="uxLastName" CssClass="span-3 last"
            runat="server" Text="LastName :" />
        <ektronUI:TextField ID="uxLastName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxDisplayLabel" AssociatedControlID="uxDisplay" CssClass="span-3 last"
            runat="server" Text="Display :" />
        <ektronUI:TextField ID="uxDisplay" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxEmailLabel" AssociatedControlID="uxEmail" CssClass="span-3 last"
            runat="server" Text="Email :" />
        <ektronUI:TextField ID="uxEmail" 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>
    <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Update"></ektronUI:Button>
</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.User;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            UserManager Usermanager = new UserManager();
            long userID = long.Parse(uxUserId.Text);
            //Check the Valid EmailAddress or Not
            string emailAddress = uxEmail.Text;
            if (!string.IsNullOrEmpty(emailAddress))
            {
                try
                {
                    System.Net.Mail.MailAddress addr = new System.Net.Mail.MailAddress(emailAddress);
                }
                catch 
                {
                    uxStatus.Visible = true;
                    MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid Email Address.", Message.DisplayModes.Error);
                    return;
                }
            }

            //Set the User Details
            UserData Userdata = Usermanager.GetItem(userID, true);
            if (Userdata != null)
            {
                Userdata.Username = uxUserName.Text != string.Empty ? uxUserName.Text : Userdata.Username;
                Userdata.Password = uxPassword.Text != string.Empty ? uxPassword.Text : Userdata.Password;
                Userdata.FirstName = uxFirstName.Text != string.Empty ? uxFirstName.Text : Userdata.FirstName;
                Userdata.LastName = uxLastName.Text != string.Empty ? uxLastName.Text : Userdata.LastName;
                Userdata.DisplayName = uxDisplay.Text != string.Empty ? uxDisplay.Text : Userdata.DisplayName;
                Userdata.Email = uxEmail.Text != string.Empty ? uxEmail.Text : Userdata.Email;

                Userdata.CustomProperties["Phone"].Value = "603-555-9999";
                Userdata.CustomProperties["Time Zone"].Value = "Eastern Standard Time";

                //Updates the UserDetails
                Usermanager.Update(Userdata);
                MessageUtilities.UpdateMessage(uxMessage, "User Details has been Updated for UserID :" + Userdata.Id, Message.DisplayModes.Success);              


            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please Enter Valid UserID", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }

    }

UserCriteria

Namespace

Ektron.Cms.User

Properties

• ReturnCustomeProperties. Gets or sets the ReturnCustomProperties flag. If true, each user's custom properties also will be returned with results.

  public bool ReturnCustomProperties { set; get; }

• UserCriteria()

  public UserCriteria()

• UserCriteria(Ektron.Cms.User.UserProperty, EkEnumeration.OrderByDirection)

  public UserCriteria(Ektron.Cms.User.UserProperty
    orderByField, EkEnumeration.OrderByDirection orderByDirection)

  Accepted fields for the UserProperty are:

  • AcceptedTerms
  • Address
  • AddressName
  • AuthenticationTypeId
  • AuthenticationUserId
  • AuthGuid
  • Avatar
  • DateCreated
  • DisplayName
  • DisplayUserName
  • Domain
  • EditorOpen
  • Email
  • FirstName
  • Id
  • IsActivated
  • IsDeleted
  • IsDisableMessage
  • IsMemberShip
  • LanguageId
  • LastLoginDate
  • LastName
  • Latitude
  • LoginAttempts
  • LoginIdentification
  • Longitude
  • Path
  • Signature
  • UserName
  • VerifyGuid

UserCustomPropertyCriteria

Namespace

Ektron.Cms.User

Properties

• AddFilter(string, Ektron.Cms.Common.CriteriaFilterOperator, object). Adds a Custom property based filter to the criteria object and returns the UserCustomPropertyFilterGroup that was created.

  public Ektron.Cms.User.UserCustomPropertyFilterGroup
    AddFilter(string propertyName,
    Ektron.Cms.Common.CriteriaFilterOperator
    filterOperator, object value)

• AddFilter(long, Ektron.Cms.Common.CriteriaFilterOperator, object). Adds a custom property based filter to the criteria object and returns the UserCustomPropertyFilterGroup that was created.

  public Ektron.Cms.User.UserCustomPropertyFilterGroup
    AddFilter(long propertyId,
    Ektron.Cms.Common.CriteriaFilterOperator
    filterOperator, object value)

• CustomPropertyFilterGroups

  public System.Collections.Generic.List<UserCustomPropertyFilterGroup>
    CustomPropertyFilterGroups { set; get; }

• GenerateSql(System.Data.Common.DbCommand, System.Collections.Generic.Dictionary<Ektron.Cms.User.UserProperty,string>, out string, out string)

  public override void GenerateSql(System.Data.Common.DbCommand command,
    System.Collections.Generic.Dictionary<UserProperty,string>
    columnMap, out string whereClause, out string orderByClause)

• ToCacheKey()

  public override string ToCacheKey()

• UserCustomPropertyCriteria()

  public UserCustomPropertyCriteria()

• UserCustomPropertyCriteria(Ektron.Cms.User.UserProperty, EkEnumeration.OrderByDirection)

  public UserCustomPropertyCriteria(Ektron.Cms.User.UserProperty
    orderByField, EkEnumeration.OrderByDirection orderByDirection)

  Accepted fields for the UserProperty are:

  • AcceptedTerms
  • Address
  • AddressName
  • AuthenticationTypeId
  • AuthenticationUserId
  • AuthGuid
  • Avatar
  • DateCreated
  • DisplayName
  • DisplayUserName
  • Domain
  • EditorOpen
  • Email
  • FirstName
  • Id
  • IsActivated
  • IsDeleted
  • IsDisableMessage
  • IsMemberShip
  • LanguageId
  • LastLoginDate
  • LastName
  • Latitude
  • LoginAttempts
  • LoginIdentification
  • Longitude
  • Path
  • Signature
  • UserName
  • VerifyGuid

UserData

Namespace

Ektron.Cms

Properties

• AcceptedTerms. Gets or set whether the user has accepted the Terms and Conditions associated with a Threaded Discussion. This is for the UserData object. Returns boolean indicating whether the user has accepted the Terms and Conditions associated with a Threaded Discussion.

  public bool AcceptedTerms { set; get; }

• Add(string). Adds a custom attribute by name

  public void Add(string sName)

• AdUserName. Obsolete: Gets or sets the Active Directory user name for the UserData object.

  public string AdUserName { set; get; }

• AttributeList. Gets custom attribute list as array

  public Ektron.Cms.CustomAttribute[] AttributeList { set; get; }

• AuthenticationToken. Gets or sets the authentication token assigned to this user for non-logged-in authentication purposes.

  public string AuthenticationToken { set; get; }

• AuthenticationTokenExpires. Gets or sets the datetime when the current authentication token expires.

  public System.DateTime AuthenticationTokenExpires { set; get; }

• AuthenticationTypeId. Gets or sets the ID of the authentication type this user uses to authenticate against for the CMS. For example, EkEnumeration.UserAuthenticationType.Facebook is used for integrated Facebook authentication.

  public long AuthenticationTypeId { set; get; }

• AuthenticationUserId. Gets or sets the id associated with this user in the third party authentication process. For Example, when AuthenticationTypeId is EkEnumeration.UserAuthenticationType.Facebook, AuthenticationUserId would be the user's Facebook User ID.

  public string AuthenticationUserId { set; get; }

• AuthGuid. Obsolete: When using a non CMS authentication method, the guid of the user in that system. Example: Active Directory objectGuid.

  public string AuthGuid { set; get; }

• CustomAttribute(string). Gets a customAttribute instance by name

  public Ektron.Cms.CustomAttribute CustomAttribute(string sName)

• CustomProperties. Gets the current users list of custom properties.

  public Ektron.Cms.CustomAttributeList CustomProperties { set; get; }

• DateCreated. Gets or sets the creation date of a user. This is for the UserData object. Returns the date the user was created.

  public string DateCreated { set; get; }

• DateModified. Gets the last modified date of a user. This is for the UserData object. Returns the date the user was last modified.

  public System.DateTime DateModified { set; get; }

• EditorOption. Represents the content editor type configured on this user

  public string EditorOption { set; get; }

• GetCustomAttributes(). Gets Custom attributes

  public Ektron.Cms.CustomAttributeList GetCustomAtrributes()

• GetUserattributes(). Gets all custom attributes for this user and returns a list custom attributes.

  public Ektron.Cms.CustomAttributeList GetUserAttributes()

• GroupId. Obsolete: To retrieve a list of groups this User belongs to use Ektron.Cms.API.User.GetAllUserGroups() function. Gets or sets the numeruc ID (Long) of the group to which the user belongs. This is for the UserData object. Returns the group ID to which the user belongs.

  public long GroupId { set; get; }

• GroupName. Obsolete: To retrieve a list of groups this User belongs to use Ektron.Cms.API.User.GetAllUserGroups() function. Gets or sets the numeric ID (Long) of the group to which the user belongs. This is for the UserData object. Returns the name of the group to which the user belongs.

  public string GroupName { set; get; }

• IsAccountLocked(EkRequestInformation). Gets a flag that indicates whether this account is locked or not and returns true when account is locked; false when not.

  public bool IsAccountLocked(EkRequestInformation reqInfo)

• IsDeleted. Gets or sets a boolean flag that indicates if the user was deleted.

  public bool IsDeleted { set; get; }

• IsDisableMessage. Gets or sets a flag that indicates whether messaging is enabled or disabled for this user.

  public bool IsDisableMessage { set; get; }

• IsMemberShip. Gets or sets a boolean indicating whether the user is a Membership user or not. This is for UserData object. Returns a boolean indicating whether the user is a Membership user.

  public bool IsMemberShip { set; get; }

• LanguageId. Gets or sets the integer ID of the language for the UserData object and returns the integer ID of the language.

  public int LanguageId { set; get; }

• LanguageName. Gets the name of the user's language for the UserData object and returns the name of the user's language.

  public string LanguageName { set; get; }

• LastLoginDate. Gets or sets the last date a user logged into Ektron CMS. This is for the UserData object. Returns the last login date for a user.

  public string LastLoginDate { set; get; }

• LastPasswordChangeDate. Gets or sets the last date a user changed their password. Returns the date when the user last changed the password.

  public System.DateTime LastPasswordChangeDate { set; get; }

• LoginAttempts. Gets an Int16 representing the number of times a user has attempted to login for the UserData object. This number resets to 0 (zero) once a user successfully logs in.

  public short LoginAttempts { set

• LoginIdentification. Gets or sets a unique login ID

  public string LoginIdentification { set; get; }

• PasswordExpired(int). Gets a boolean representing if the user's password would expire given a certain amount of days from today's date and returns true when password expired; false otherwise.

  public bool PasswordExpired(int expirationPeriodInDays)

• Path. Obsolete.

  public string Path { set; get; }

• Rank. Gets or sets the user's rank for a Threaded Discussion for the UserData object and returns the user's rank for a Threaded Discussion.

  public Ektron.Cms.UserRank Rank { set; get; }

• SessionId. Gets the users current session Id.

  public System.Guid SessionId { set; get; }

• Signature. Gets or sets the user's signature for the UserData object, used in the forums and other locations.

  public string Signature { set; get; }

• UserPreference. Gets or sets a user's preferences as UserPreferenceData for the UserData object.

  public Ektron.Cms.UserPreferenceData UserPreference { set; get; }

• Validate(). Validate this instance's data.

  public override ValidationResults Validate()

UserTaxonomyCriteria

Namespace

Ektron.Cms.User

Properties

• AddFilter(string, [bool])

  public Ektron.Cms.User.UserTaxonomyFilterGroup
    AddFilter(string taxonomyPath, [bool recursive = false])

• AddFilter(long, [bool])

  public Ektron.Cms.User.UserTaxonomyFilterGroup
    AddFilter(long taxonomyId, [bool recursive = false])

• AddFilter(Ektron.Cms.User.UserTaxonomyProperty, Ektron.Cms.Common.CriteriaFilterOperator, object, [bool])

  public Ektron.Cms.User.UserTaxonomyFilterGroup
    AddFilter(Ektron.Cms.User.UserTaxonomyProperty
    taxonomyProperty, Ektron.Cms.Common.CriteriaFilterOperator
    filterOperator, object value, [bool recursive = false])

• GenerateSql(System.Data.Common.DbCommand, System.Collections.Generic.Dictionary<Ektron.Cms.User.UserProperty,string>, out string, out string)

  public override void GenerateSql(System.Data.Common.DbCommand command,
    System.Collections.Generic.Dictionary<UserProperty,string>
    columnMap, out string whereClause, out string orderByClause)

• ToCacheKey()

  public override string ToCacheKey()

• UserTaxonomyCriteria()

  public UserTaxonomyCriteria()

• UserTaxonomyCriteria(Ektron.Cms.User.UserProperty, EkEnumeration.OrderByDirection)

  public UserTaxonomyCriteria(Ektron.Cms.User.UserProperty
    orderByField, EkEnumeration.OrderByDirection orderByDirection)

  Accepted fields for the UserProperty are:

  • AcceptedTerms
  • Address
  • AddressName
  • AuthenticationTypeId
  • AuthenticationUserId
  • AuthGuid
  • Avatar
  • DateCreated
  • DisplayName
  • DisplayUserName
  • Domain
  • EditorOpen
  • Email
  • FirstName
  • Id
  • IsActivated
  • IsDeleted
  • IsDisableMessage
  • IsMemberShip
  • LanguageId
  • LastLoginDate
  • LastName
  • Latitude
  • LoginAttempts
  • LoginIdentification
  • Longitude
  • Path
  • Signature
  • UserName
  • VerifyGuid