CommunityGroupManager
The CommunityGroupManager class manages groups of users.
Namespace
Ektron.Cms.Framework.Community.CommunityGroupManager
Constructors
Constructors
CommunityGroupManager()CommunityGroupManager(ApiAccessMode)
Properties
Properties
ApiMode. Gets or sets the current API access mode. If set toAdmin, the API runs with the permissions of an administrator.ApplicationPath.
Gets the application path to the Workarea.CommunityGroupManagerService. Returns an instance of the business objects task manager service.ContentLanguage. Gets or sets the current content language.InPreviewMode. Gets or sets the preview mode and returns true if the site is in preview mode.IsCommerceEnabled.
Checks for a commerce license.RequestInformation. Gets information about the current request.SitePath. Gets the site path.UserId. Gets or sets the ID of the currently logged-in user.
Methods
Methods
AcceptInvite. Accepts an invitation of a community group.
AcceptInvite
AcceptInvite(System.Int64,System.Int64)
Accepts an invitation of a community 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
- * Community Group ID
- * User ID
Parameters
communityGroupId. ID of the community group.userId. ID of the user.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxCommunityGroupIdLabel" AssociatedControlID="uxCommunityGroupId" CssClass="span-4 last" runat="server" Text="* Community Group Id :" />
<ektronUI:TextField ID="uxCommunityGroupId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-6 last" runat="server" Text="* User Id :" />
<ektronUI:TextField ID="uxUserId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" Text="8" />
</li>
<li class="clearfix">
<ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Accept Invite"></ektronUI:Button>
<ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using Ektron.Cms.Framework.Community;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
long communityGroupId = long.Parse(uxCommunityGroupId.Text);
long userId = long.Parse(uxUserId.Text);
CommunityGroupManager communityGroupManager = new CommunityGroupManager();
communityGroupManager.AcceptInvite(communityGroupId, userId);
MessageUtilities.UpdateMessage(uxMessage, "Invite accepted by User with Id " + userId, Message.DisplayModes.Success);
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
Add. Adds a new Community Group.
Add
Add(Ektron.Cms.CommunityGroupData)
Adds a community group.
When you add the community group data, the method returns a custom CMSData 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
- * Group Name
- Enable Distribute
- Enable Group Mail
- Group Image
- * Group Admin Id
- Short Description
- Long Description
Parameters
communityGroupData. The CommunityGroupData object to add.
Returns
Returns the custom CommunityGroupData object added.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxGroupNameLabel" AssociatedControlID="uxGroupName" CssClass="span-4 last" runat="server" Text="* Group Name:" />
<ektronUI:TextField ID="uxGroupName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxGroupEnableDistributeLabel" AssociatedControlID="uxGroupEnableDistribute" CssClass="span-4 last" runat="server" Text="Group Enable Distribute:" />
<asp:CheckBox id="uxGroupEnableDistribute" runat="server" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxEnableGroupEmailsLabel" AssociatedControlID="uxEnableGroupEmails" CssClass="span-4 last" runat="server" Text="Enable Group Email:" />
<asp:checkbox ID="uxEnableGroupEmails" runat="server" AutoPostBack="true" OnCheckedChanged="uxEnableGroupEmails_OnCheckedChanged" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxEmailAccountNameLabel" AssociatedControlID="uxEmailAccountName" CssClass="span-4 last" runat="server" Text="Email Account Name:" Enabled="false" />
<ektronUI:TextField ID="uxEmailAccountName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Enabled="false" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxEmailAddressLabel" AssociatedControlID="uxEmailAddress" CssClass="span-4 last" runat="server" Text="Email Address:" Enabled="false" />
<ektronUI:TextField ID="uxEmailAddress" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Enabled="false" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxEmailPasswordLabel" AssociatedControlID="uxEmailPassword" CssClass="span-4 last" runat="server" Text="Email Password:" Enabled="false" />
<ektronUI:TextField ID="uxEmailPassword" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Enabled="false" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxGroupImageLabel" AssociatedControlID="uxGroupImage" CssClass="span-4 last" runat="server" Text="Group Image:" />
<asp:FileUpload ID="uxGroupImage" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" size="29.75" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxGroupAdminLabel" AssociatedControlID="uxGroupAdmin" CssClass="span-4 last" runat="server" Text="* Group Admin Id:" />
<ektronUI:TextField ID="uxGroupAdmin" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxGroupShortDescriptionLabel" AssociatedControlID="uxGroupShortDescription" CssClass="span-4 last" runat="server" Text="Short Description:" />
<ektronUI:TextField ID="uxGroupShortDescription" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxGroupLongDescriptionLabel" AssociatedControlID="uxGroupLongDescription" CssClass="span-4 last" runat="server" Text="Long Description:" />
<asp:TextBox TextMode="MultiLine" Rows="3" ID="uxGroupLongDescription" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxRequiredLabel" CssClass="span-4 last" runat="server" Text="* - Required" />
<ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add"></ektronUI:Button>
</li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using Ektron.Cms; using Ektron.Storage; using Microsoft.VisualBasic; using Ektron.Cms.Framework.User; using Ektron.Cms.Framework.Community;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
UserManager Usermanager = new UserManager();
long groupAdminId;
long.TryParse(uxGroupAdmin.Text, out groupAdminId);
if (!String.IsNullOrWhiteSpace(uxGroupName.Text))
{
UserData userBaseData = Usermanager.GetItem(groupAdminId);
List<UserData> userlist = new List<UserData>();
if (userBaseData != null && userBaseData.Id != 0)
{
userlist.Add(userBaseData);
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Please enter valid Group Admin Id.", Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
return;
}
CommunityGroupManager communityGroupManager = new CommunityGroupManager();
CommunityGroupData communityGroupData = new CommunityGroupData()
{
Name = uxGroupName.Text,
EnableDistributeToSite = uxGroupEnableDistribute.Checked,
LongDescription = uxGroupLongDescription.Text,
EnableGroupEmail = uxEnableGroupEmails.Checked,
Admins = userlist,
};
if (communityGroupData.EnableGroupEmail == true)
{
if (!String.IsNullOrWhiteSpace(uxEmailAccountName.Text) && !String.IsNullOrWhiteSpace(uxEmailAddress.Text) && !String.IsNullOrWhiteSpace(uxEmailPassword.Text))
{
String expression = @"^([a-zA-Z0-9_\-\.]+)@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([a-zA-Z0-9\-]+\.)+))([a-zA-Z]{2,4}|[0-9]{1,3})(\]?)$";
if (!System.Text.RegularExpressions.Regex.IsMatch(uxEmailAddress.Text, expression))
{
MessageUtilities.UpdateMessage(uxMessage, "Please enter valid EmailAddress.", Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
return;
}
communityGroupData.EmailAccountName = uxEmailAccountName.Text;
communityGroupData.EmailAddress = uxEmailAddress.Text;
communityGroupData.EmailPassword = uxEmailPassword.Text;
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Need valid EmailAddress, EmailPassword, and EmailAccountName when EnableGroupEmail is enabled.", Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
return;
}
}
if (uxGroupImage.HasFile)
{
if ((uxGroupImage.PostedFile.ContentType == "image/pjpeg") || (uxGroupImage.PostedFile.ContentType == "image/jpeg") || (uxGroupImage.PostedFile.ContentType == "image/gif"))
{
string[] fileNameArray = Strings.Split(uxGroupImage.PostedFile.FileName, "\\", -1, 0);
string strFileName = (System.Guid.NewGuid().ToString()).Substring(0, 5) + "_g_" + fileNameArray[(fileNameArray.Length - 1)];
StorageClient.Context.File.UploadStream(uxGroupImage.PostedFile.InputStream, Server.MapPath(communityGroupManager.SitePath + "uploadedimages/" + strFileName));
Utilities.ProcessThumbnail(Server.MapPath(communityGroupManager.SitePath + "uploadedimages/"), strFileName);
communityGroupData.Image = communityGroupManager.SitePath + "uploadedimages/thumb_" + Utilities.GetCorrectThumbnailFileWithExtn(strFileName);
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Not a valid jpeg/gif image.", Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
return;
}
}
if (!string.IsNullOrWhiteSpace(uxGroupShortDescription.Text))
{
if (uxGroupShortDescription.Text.Length > 100)
{
MessageUtilities.UpdateMessage(uxMessage, "Short Description should not exceed 100 characters.", Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
return;
}
communityGroupData.ShortDescription = uxGroupShortDescription.Text;
}
if (communityGroupManager.RequestInformation.UserId > 0)
{
communityGroupManager.Add(communityGroupData);
MessageUtilities.UpdateMessage(uxMessage, "Community Group Added with Id " + communityGroupData.Id, Message.DisplayModes.Success);
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Login required to add a community group", Message.DisplayModes.Error);
}
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Please enter valid Group Name.", Message.DisplayModes.Error);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
AddUser. Adds a user to a community group.
AddUser
AddUser(System.Int64,System.Int64)
Adds a user to a community 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
- * Community Group ID
- * User ID
Parameters
communityGroupId. ID of the community group.userId. ID of the user.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxCommunityGroupIdLabel" AssociatedControlID="uxCommunityGroupId" CssClass="span-4 last" runat="server" Text="* Community Group Id :" />
<ektronUI:TextField ID="uxCommunityGroupId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
</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-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="8" />
</li>
<li class="clearfix">
<ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Add User"></ektronUI:Button>
<ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using Ektron.Cms.Framework.Community;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
long communityGroupId = long.Parse(uxCommunityGroupId.Text);
long userId = long.Parse(uxUserId.Text);
UserManager Usermanager = new UserManager();
UserData Userdata = Usermanager.GetItem(userId);
if (Userdata != null)
{
CommunityGroupManager communityGroupManager = new CommunityGroupManager();
communityGroupManager.AddUser(communityGroupId, userId);
MessageUtilities.UpdateMessage(uxMessage, "User with ID " + userId + " is added to Community Group with ID " + communityGroupId, Message.DisplayModes.Success);
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "User with ID " + userId + " does not exists.", Message.DisplayModes.Error);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
ApproveJoin. Accepts a join request of a community group.
ApproveJoin
DeclineJoin(System.Int64,System.Int64)
Accepts a join request of a community 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
- * Community Group ID
- * User ID
Parameters
communityGroupId. ID of the community group.userId. ID of the user.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxCommunityGroupIdLabel" AssociatedControlID="uxCommunityGroupId" CssClass="span-4 last" runat="server" Text="* Community Group Id :" />
<ektronUI:TextField ID="uxCommunityGroupId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-6 last" runat="server" Text="* User Id :" />
<ektronUI:TextField ID="uxUserId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" Text="8" />
</li>
<li class="clearfix">
<ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="ApproveJoin"></ektronUI:Button>
<ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using Ektron.Cms.Framework.Community;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
long communityGroupId = long.Parse(uxCommunityGroupId.Text);
long userId = long.Parse(uxUserId.Text);
CommunityGroupManager communityGroupManager = new CommunityGroupManager();
communityGroupManager.ApproveJoin(communityGroupId, userId);
MessageUtilities.UpdateMessage(uxMessage, "Join accepted by User with Id " + userId, Message.DisplayModes.Success);
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
DeclineInvite. Declines an invitation of a community group.
DeclineInvite
DeclineInvite(System.Int64,System.Int64)
Declines an invitation of a community 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
- * Community Group ID
- * User ID
Parameters
communityGroupId. ID of the community group.userId. ID of the user.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxCommunityGroupIdLabel" AssociatedControlID="uxCommunityGroupId" CssClass="span-4 last" runat="server" Text="* Community Group Id :" />
<ektronUI:TextField ID="uxCommunityGroupId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
</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-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="8" />
</li>
<li class="clearfix">
<ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Decline Invite"></ektronUI:Button>
<ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using Ektron.Cms.Framework.Community;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
long communityGroupId = long.Parse(uxCommunityGroupId.Text);
long userId = long.Parse(uxUserId.Text);
CommunityGroupManager communityGroupManager = new CommunityGroupManager();
communityGroupManager.DeclineInvite(communityGroupId, userId);
MessageUtilities.UpdateMessage(uxMessage, "Invite declined by User with Id " + userId, Message.DisplayModes.Success);
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
DeclineJoin. Declines a join request of a community group.
DeclineJoin
DeclineJoin(System.Int64,System.Int64)
Declines a join request of a community 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
- * Community Group ID
- * User ID
Parameters
communityGroupId. ID of the community group.userId. ID of the user.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxCommunityGroupIdLabel" AssociatedControlID="uxCommunityGroupId" CssClass="span-4 last" runat="server" Text="* Community Group Id :" />
<ektronUI:TextField ID="uxCommunityGroupId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
</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-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="8" />
</li>
<li class="clearfix">
<ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Decline Join"></ektronUI:Button>
<ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using Ektron.Cms.Framework.Community;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
long communityGroupId = long.Parse(uxCommunityGroupId.Text);
long userId = long.Parse(uxUserId.Text);
CommunityGroupManager communityGroupManager = new CommunityGroupManager();
communityGroupManager.DeclineJoin(communityGroupId, userId);
MessageUtilities.UpdateMessage(uxMessage, "Join declined by User with Id " + userId, Message.DisplayModes.Success);
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
Delete. Deletes a community group.
Delete
Delete(System.Int64)
Deletes a community group from the CMS.
Authenticated users
- CMS Administrators
To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.
Fields
*=Required
- * ID
Parameters
ID. ID of the community group to delete.
Remarks
Validate the item using GetItem() before deleting.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxCommunityGroupIdLabel" AssociatedControlID="uxCommunityGroupId" CssClass="span-3 last" runat="server" Text="* Id:" />
<ektronUI:TextField ID="uxCommunityGroupId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
</li>
<li class="clearfix" style="color: red;">
<ektronUI:Label ID="uxStatus" Visible="false" CssClass="span-9 last" runat="server"
Text="Status:" />
</li>
<li class="clearfix">
<ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Delete"></ektronUI:Button>
<ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" />
</li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using Ektron.Cms.Framework.Community; using Ektron.Cms;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
long communityGroupId = long.Parse(uxCommunityGroupId.Text);
CommunityGroupManager communityGroupManager = new CommunityGroupManager();
CommunityGroupData communityGroupData = communityGroupManager.GetItem(communityGroupId);
if (communityGroupData != null)
{
communityGroupManager.Delete(communityGroupId);
MessageUtilities.UpdateMessage(uxMessage, "Community Group with Id " + communityGroupId + " deleted.", Message.DisplayModes.Success);
}
else
{
uxStatus.Visible = true;
MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid CommunityGroup Id.", Message.DisplayModes.Error);
return;
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
GetAdminList. Retrieves a list of administrator users for a community group ID.
GetAdminList
GetAdminList(System.Int64)
Retrieves a list of administrator users for a community group 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
- * Community Group ID
Parameters
communityGroupId. ID of the community group.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxCommunityGroupIdLabel" AssociatedControlID="uxCommunityGroupId" CssClass="span-3 last" runat="server" Text="* Id :" />
<ektronUI:TextField ID="uxCommunityGroupId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
</li>
<li class="clearfix">
<ektronUI:Message ID="uxStatus" DisplayMode="Error" runat="server" Visible="false" />
</li>
<li class="clearfix">
<ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetAdminList"></ektronUI:Button>
<ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" />
</li>
</ol>
<ektronUI:Message ID="uxMessage" DisplayMode="Information" Visible="false" runat="server" />
<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>
FirstName
</th>
<th>
LastName
</th>
<th>
DisplayName
</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("FirstName")%>
</td>
<td class="devsite-method">
<%# Eval("LastName")%>
</td>
<td class="devsite-method">
<%# Eval("DisplayName")%>
</td>
</tr>
</ItemTemplate>
</asp:ListView>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using Ektron.Cms; using Ektron.Cms.Framework.Community;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
long communityGroupId = long.Parse(uxCommunityGroupId.Text);
CommunityGroupManager communityGroupManager = new CommunityGroupManager();
CommunityGroupData communityGroupData = communityGroupManager.GetItem(communityGroupId);
if (communityGroupData != null)
{
List<UserData> userlist = communityGroupManager.GetAdminList(communityGroupId);
uxUserlist.Visible = true;
uxUserlist.DataSource = userlist;
uxUserlist.DataBind();
}
else
{
uxStatus.Visible = true;
MessageUtilities.UpdateMessage(uxStatus, "Please Enter Valid CommunityGroup Id.", Message.DisplayModes.Error);
return;
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
GetBlogId. Retrieves the blog ID of the community group.
GetBlogId
GetBlogId(System.Int64)
Retrieves the blog ID of the community 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
- * Community Group ID
Parameters
communityGroupId. ID of the community group.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxCommunityGroupIdLabel" AssociatedControlID="uxCommunityGroupId" CssClass="span-4 last" runat="server" Text="* Community Group Id :" />
<ektronUI:TextField ID="uxCommunityGroupId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
</li>
<li class="clearfix">
<ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Blog Id"></ektronUI:Button>
<ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" />
</li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using Ektron.Cms.Framework.Community;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
long communityGroupId = long.Parse(uxCommunityGroupId.Text);
CommunityGroupManager communityGroupManager = new CommunityGroupManager();
long blogId = communityGroupManager.GetBlogId(communityGroupId);
if (blogId == 0)
{
MessageUtilities.UpdateMessage(uxMessage, "Either the community group does not exists or the community group has no blog.", Message.DisplayModes.Error);
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Blog Id : " + blogId, Message.DisplayModes.Success);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
GetCalendarId. Retrieves the calendar ID of the community group.
GetCalendarId
GetCalendarId(System.Int64)
Retrieves the calendar ID of the community 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
- * Community Group ID
Parameters
communityGroupId. ID of the community group.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxCommunityGroupIdLabel" AssociatedControlID="uxCommunityGroupId" CssClass="span-4 last" runat="server" Text="* Community Group Id :" />
<ektronUI:TextField ID="uxCommunityGroupId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
</li>
<li class="clearfix">
<ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Calendar Id"></ektronUI:Button>
<ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" />
</li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using Ektron.Cms.Framework.Community;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
long communityGroupId = long.Parse(uxCommunityGroupId.Text);
CommunityGroupManager communityGroupManager = new CommunityGroupManager();
long calendarId = communityGroupManager.GetCalendarId(communityGroupId);
if (calendarId == 0)
{
MessageUtilities.UpdateMessage(uxMessage, "Either the Community group does not exists or or the community group has no calendar.", Message.DisplayModes.Error);
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Calendar Id : " + calendarId, Message.DisplayModes.Success);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
GetDiscussionBoardId. Retrieves the discussion board ID of the community group.
GetDiscussionBoardId
GetDiscussionBoardId(System.Int64)
Retrieves the discussion board ID of the community 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
- * Community Group ID
Parameters
communityGroupId. ID of the community group.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxCommunityGroupIdLabel" AssociatedControlID="uxCommunityGroupId" CssClass="span-4 last" runat="server" Text="* Community Group Id :" />
<ektronUI:TextField ID="uxCommunityGroupId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
</li>
<li class="clearfix">
<ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Discussion Board Id"></ektronUI:Button>
<ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" />
</li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using Ektron.Cms.Framework.Community;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
long communityGroupId = long.Parse(uxCommunityGroupId.Text);
CommunityGroupManager communityGroupManager = new CommunityGroupManager();
long discussionBoardId = communityGroupManager.GetDiscussionBoardId(communityGroupId);
if (discussionBoardId == 0)
{
MessageUtilities.UpdateMessage(uxMessage, "Either the Community group does not exists or the community group has no discussion board.", Message.DisplayModes.Error);
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Discussion Board Id : " + discussionBoardId, Message.DisplayModes.Success);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
GetFolderId. Retrieves the folder ID of the community group.
GetFolderId
GetFolderId(System.Int64)
Retrieves the folder ID of the community 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
- * Community Group ID
Parameters
communityGroupId. ID of the community group.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxCommunityGroupIdLabel" AssociatedControlID="uxCommunityGroupId" CssClass="span-4 last" runat="server" Text="* Community Group Id :" />
<ektronUI:TextField ID="uxCommunityGroupId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
</li>
<li class="clearfix">
<ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Folder Id"></ektronUI:Button>
<ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" />
</li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using Ektron.Cms.Framework.Community;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
long communityGroupId = long.Parse(uxCommunityGroupId.Text);
CommunityGroupManager communityGroupManager = new CommunityGroupManager();
long folderId = communityGroupManager.GetFolderId(communityGroupId);
if (folderId == 0)
{
MessageUtilities.UpdateMessage(uxMessage, "Community group does not exists.", Message.DisplayModes.Error);
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Folder Id : " + folderId, Message.DisplayModes.Success);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
GetItem. Retrieves the properties of a specific CommunityGroupData object.
GetItem
GetItem(System.Int64)
Retrieves the properties of a specific CommunityGroupData object.
Authenticated users
- CMS Administrators
- Users that have access permission
To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.
Fields
*=Required
- * Community Group ID
Parameters
id. ID of the community group to get.
Returns
Community group details in a CommunityGroupData object.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxCommunityGroupIdLabel" AssociatedControlID="uxCommunityGroupId" CssClass="span-3 last" runat="server" Text="* Id :" />
<ektronUI:TextField ID="uxCommunityGroupId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
</li>
<li class="clearfix">
<ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Item"></ektronUI:Button>
<ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" />
</li>
</ol>
<ol class="formFields">
<li class="clearfix">
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
</li>
<li class="clearfix">
<asp:Literal ID="uxGroupName" runat="server"></asp:Literal>
</li>
<li class="clearfix">
<asp:Literal ID="uxGroupAdmin" runat="server"></asp:Literal>
</li>
<li class="clearfix">
<asp:Literal ID="uxGroupEnableDistribute" runat="server"></asp:Literal>
</li>
<li class="clearfix">
<asp:Literal ID="uxGroupLongDescription" runat="server"></asp:Literal>
</li>
<li class="clearfix">
<asp:Literal ID="uxGroupShortDescription" runat="server"></asp:Literal>
</li>
</ol>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using Ektron.Cms; using Ektron.Cms.Framework.Community;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
long communityGroupId = long.Parse(uxCommunityGroupId.Text);
CommunityGroupManager communityGroupManager = new CommunityGroupManager();
CommunityGroupData communityGroupData = communityGroupManager.GetItem(communityGroupId);
if(communityGroupData != null)
{
MessageUtilities.UpdateMessage(uxMessage, "Details for community group with ID " + communityGroupData.Id.ToString() + " are below", Message.DisplayModes.Success);
uxGroupName.Text = "Group Name : " + communityGroupData.Name;
uxGroupEnableDistribute.Text = "Group Enable Distribute : " + communityGroupData.EnableDistributeToSite;
uxGroupLongDescription.Text = "Group Long Description : " + communityGroupData.LongDescription;
uxGroupShortDescription.Text = "Group Short Description : " + communityGroupData.ShortDescription;
uxGroupAdmin.Text = "Group Admin :" + communityGroupData.Admins[0].Username;
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Community group does not exist. ", Message.DisplayModes.Error);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
GetList (CommunityGroupCriteria). Retrieves community groups associated with the specified users.
GetList (CommunityGroupCriteria)
GetList(Ektron.Cms.Community.CommunityGroupCriteria)
Retrieves community groups associated with the specified users. Username or UserId are required criteria for this method to return data.
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
- Community Group Property
- * Object Value
Parameters
criteria. Used to specify, or filter, the community groups to return.
Returns
A list of community groups.
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="uxCommunityGroupPropertyLabel" AssociatedControlID="uxCommunityGroupProperty" CssClass="span-4 last" runat="server" Text="CommunityGroupProperty:" />
<asp:DropDownList ID="uxCommunityGroupProperty" runat="server">
<asp:ListItem>Group Id</asp:ListItem>
<asp:ListItem>Group Name</asp:ListItem>
</asp:DropDownList>
</li>
<li class="clearfix">
<ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-4 last" runat="server" Text="* ObjectValue:" />
<ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
</li>
<li class="clearfix">
<ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get List"></ektronUI:Button>
<ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
<asp:ListView ID="uxcommunityGroupListView" runat="server" ItemPlaceholderID="aspItemPlaceholder" Visible="false">
<EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
<LayoutTemplate>
<table class="devsite-api-method">
<thead>
<tr>
<th>
Group Name
</th>
<th>
Group Id
</th>
<th>
Group Long Description
</th>
</tr>
</thead>
<tbody>
<asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
</tbody>
</table>
</LayoutTemplate>
<ItemTemplate>
<tr>
<td class="devsite-method">
<%# Eval("GroupName")%>
</td>
<td class="devsite-method">
<%# Eval("GroupId")%>
</td>
<td class="devsite-method">
<%# Eval("GroupLongDescription")%>
</td>
</tr>
</ItemTemplate>
</asp:ListView>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using Ektron.Cms; using Ektron.Cms.Common; using Ektron.Cms.Framework.Community;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
object Objectvalue;
Ektron.Cms.Community.CommunityGroupCriteria criteria = new Ektron.Cms.Community.CommunityGroupCriteria();
if (uxCommunityGroupProperty.SelectedItem.Text == "Group Id")
{
Objectvalue = Convert.ToInt64(uxObjectValue.Text);
criteria.AddFilter(CommunityGroupProperty.Id, CriteriaFilterOperator.EqualTo, Objectvalue);
}
else
{
Objectvalue = uxObjectValue.Text;
criteria.AddFilter(CommunityGroupProperty.Name, CriteriaFilterOperator.Contains, Objectvalue);
}
CommunityGroupManager communityGroupManager = new CommunityGroupManager();
List<CommunityGroupData> communityGroupList = communityGroupManager.GetList(criteria);
uxcommunityGroupListView.Visible = true;
uxcommunityGroupListView.DataSource = communityGroupList;
uxcommunityGroupListView.DataBind();
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
GetList (UserToCommunityGroupCriteria). Retrieves community groups associated with the specified users.
GetList (UserToCommunityGroupCriteria)
GetList(Ektron.Cms.Community.UserToCommunityGroupCriteria)
Returns a list of CommunityGroups that fit the supplied criteria, which in this case can be all the groups given a supplied 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 To Community Property
- * Object Value
Parameters
criteria. Used to specify, or filter, the community groups to return.
Returns
A list of community groups.
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="uxUserToCommunityGroupPropertyLabel" AssociatedControlID="uxUserToCommunityGroupProperty" CssClass="span-4 last" runat="server" Text="UserToCommunityProperty:" />
<asp:DropDownList ID="uxUserToCommunityGroupProperty" runat="server">
<asp:ListItem>User Id</asp:ListItem>
<asp:ListItem>User Name</asp:ListItem>
</asp:DropDownList>
</li>
<li class="clearfix">
<ektronUI:Label ID="uxObjectValueLabel" AssociatedControlID="uxObjectValue" CssClass="span-4 last" runat="server" Text="* ObjectValue:" />
<ektronUI:TextField ID="uxObjectValue" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
</li>
<li class="clearfix">
<ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get List"></ektronUI:Button>
<ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
<asp:ListView ID="uxcommunityGroupListView" runat="server" ItemPlaceholderID="aspItemPlaceholder" Visible="false">
<EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
<LayoutTemplate>
<table class="devsite-api-method">
<thead>
<tr>
<th>
Group Name
</th>
<th>
Group Id
</th>
<th>
Group Long Description
</th>
</tr>
</thead>
<tbody>
<asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
</tbody>
</table>
</LayoutTemplate>
<ItemTemplate>
<tr>
<td class="devsite-method">
<%# Eval("GroupName")%>
</td>
<td class="devsite-method">
<%# Eval("GroupId")%>
</td>
<td class="devsite-method">
<%# Eval("GroupLongDescription")%>
</td>
</tr>
</ItemTemplate>
</asp:ListView>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using Ektron.Cms; using Ektron.Cms.Community; using Ektron.Cms.Common; using Ektron.Cms.Framework.Community; using Ektron.Site.Developer; using Ektron.Cms.Framework.UI.Controls.EktronUI;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
object Objectvalue;
UserToCommunityGroupCriteria criteria = new UserToCommunityGroupCriteria();
criteria.OrderByField = UserToCommunityProperty.Id ;
criteria.OrderByDirection = EkEnumeration.OrderByDirection.Ascending;
if (uxUserToCommunityGroupProperty.SelectedItem.Text == "User Id")
{
Objectvalue = Convert.ToInt64(uxObjectValue.Text);
criteria.AddFilter(UserToCommunityProperty.UserId, CriteriaFilterOperator.EqualTo, Objectvalue);
}
else
{
Objectvalue = uxObjectValue.Text;
criteria.AddFilter(UserToCommunityProperty.UserName , CriteriaFilterOperator.EqualTo , Objectvalue);
}
CommunityGroupManager communityGroupManager = new CommunityGroupManager();
List<CommunityGroupData> communityGroupList = communityGroupManager.GetList(criteria);
uxcommunityGroupListView.Visible = true;
uxcommunityGroupListView.DataSource = communityGroupList;
uxcommunityGroupListView.DataBind();
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
GetMemberStatus. Retrieves the member status of the user in the community group.
GetMemberStatus
GetMemberStatus(System.Int64,System.Int64)
Retrieves the member status of the user in the community 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
- * Community Group ID
- * User ID
Parameters
communityGroupId. ID of the community group.userId. ID of the user.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxCommunityGroupIdLabel" AssociatedControlID="uxCommunityGroupId" CssClass="span-4 last" runat="server" Text="* Community Group Id :" />
<ektronUI:TextField ID="uxCommunityGroupId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
</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-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
</li>
<li class="clearfix">
<ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Member Status"></ektronUI:Button>
<ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using Ektron.Cms.Common; using Ektron.Cms.Framework.Community;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
long communityGroupId = long.Parse(uxCommunityGroupId.Text);
long userId = long.Parse(uxUserId.Text);
CommunityGroupManager communityGroupManager = new CommunityGroupManager();
EkEnumeration.GroupMemberStatus groupMemberStatus = communityGroupManager.GetMemberStatus(communityGroupId, userId);
MessageUtilities.UpdateMessage(uxMessage, "Group Member Status : " + groupMemberStatus, Message.DisplayModes.Success);
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
GetTaxonomyId. Retrieves the taxonomy ID of the community group.
GetTaxonomyId
GetTaxonomyId(System.Int64)
Retrieves the taxonomy ID of the community 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
- * Community Group ID
Parameters
communityGroupId. ID of the community group.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxCommunityGroupIdLabel" AssociatedControlID="uxCommunityGroupId" CssClass="span-4 last" runat="server" Text="* Community Group Id :" />
<ektronUI:TextField ID="uxCommunityGroupId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
</li>
<li class="clearfix">
<ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get Taxonomy Id"></ektronUI:Button>
<ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" />
</li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using Ektron.Cms.Framework.Community;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
long communityGroupId = long.Parse(uxCommunityGroupId.Text);
CommunityGroupManager communityGroupManager = new CommunityGroupManager();
long taxonomyId = communityGroupManager.GetTaxonomyId(communityGroupId);
if (taxonomyId == 0)
{
MessageUtilities.UpdateMessage(uxMessage,"Either the Community group does not exists or the community group has no taxonomy.", Message.DisplayModes.Error);
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Taxonomy Id : " + taxonomyId, Message.DisplayModes.Success);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
GetUserList. Retrieves a list of DirectoryUsers that fit the community group ID.
GetUserList
GetUserList(System.Int64)
Retrieves a list of directory users that fit the community group 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
- * ID
Parameters
communityGroupId. ID of the community group.
Returns
A list of directory users.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxCommunityGroupIdLabel" AssociatedControlID="uxCommunityGroupId" CssClass="span-3 last" runat="server" Text="* Id :" />
<ektronUI:TextField ID="uxCommunityGroupId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
</li>
<li class="clearfix">
<ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Get User List"></ektronUI:Button>
<ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" />
</li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
<asp:ListView ID="uxcommunityUserListView" runat="server" ItemPlaceholderID="aspItemPlaceholder" Visible="false">
<EmptyDataTemplate >Criteria did not match any records.</EmptyDataTemplate>
<LayoutTemplate>
<table class="devsite-api-method">
<thead>
<tr>
<th>
User Name
</th>
<th>
User Id
</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("Username")%>
</td>
<td class="devsite-method">
<%# Eval("Id")%>
</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.Cms; using Ektron.Cms.Framework.Community;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
long communityGroupId = long.Parse(uxCommunityGroupId.Text);
string userEmail = uxUserEmail.Text;
CommunityGroupManager communityGroupManager = new CommunityGroupManager();
long inviteId = communityGroupManager.Invite(communityGroupId, userEmail);
MessageUtilities.UpdateMessage(uxMessage, "Invite sent to User", Message.DisplayModes.Success);
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
Invite (email). Invites a email to a community group.
Invite
Invite(System.Int64,System.String)
Invites a email to a community 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
- * Community Group ID
- * User ID
Parameters
communityGroupId. ID of the community group.email. The email address of the user.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxCommunityGroupIdLabel" AssociatedControlID="uxCommunityGroupId" CssClass="span-4 last" runat="server" Text="* Community Group Id :" />
<ektronUI:TextField ID="uxCommunityGroupId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
</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-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="8" />
</li>
<li class="clearfix">
<ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Invite"></ektronUI:Button>
<ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using Ektron.Cms.Framework.Community;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
long communityGroupId = long.Parse(uxCommunityGroupId.Text);
long userId = long.Parse(uxUserId.Text);
CommunityGroupManager communityGroupManager = new CommunityGroupManager();
long inviteId = communityGroupManager.Invite(communityGroupId, userId);
MessageUtilities.UpdateMessage(uxMessage, "Invite sent to User", Message.DisplayModes.Success);
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
Invite (user). Invites a user to a community group.
Invite
Invite(System.Int64,System.Int64)
Invites a user to a community 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
- * Community Group ID
- * User ID
Parameters
communityGroupId. ID of the community group.userId. ID of the user.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxCommunityGroupIdLabel" AssociatedControlID="uxCommunityGroupId" CssClass="span-4 last" runat="server" Text="* Community Group Id :" />
<ektronUI:TextField ID="uxCommunityGroupId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
</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-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="8" />
</li>
<li class="clearfix">
<ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Invite"></ektronUI:Button>
<ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using Ektron.Cms.Framework.Community;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
long communityGroupId = long.Parse(uxCommunityGroupId.Text);
long userId = long.Parse(uxUserId.Text);
CommunityGroupManager communityGroupManager = new CommunityGroupManager();
long inviteId = communityGroupManager.Invite(communityGroupId, userId);
MessageUtilities.UpdateMessage(uxMessage, "Invite sent to User", Message.DisplayModes.Success);
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
IsUserInGroup. Determines if a user is in a group.
IsUserInGroup
IsUserInGroup(System.Int64,System.Int64)
Determines if a user is in a 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
- * Community Group ID
- * User ID
Parameters
communityGroupId. ID of the community group.userId. ID of the user.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxCommunityGroupIdLabel" AssociatedControlID="uxCommunityGroupId" CssClass="span-6 last" runat="server" Text="* Community Group Id :" />
<ektronUI:TextField ID="uxCommunityGroupId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxUserIdLabel" AssociatedControlID="uxUserId" CssClass="span-6 last" runat="server" Text="* User Id :" />
<ektronUI:TextField ID="uxUserId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
</li>
<li class="clearfix">
<ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Is User In Group"></ektronUI:Button>
<ektronUI:Label ID="uxRequiredLabel" CssClass="span-3" runat="server" Text="* - Required" />
</li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using Ektron.Cms.Framework.Community;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
long communityGroupId = long.Parse(uxCommunityGroupId.Text);
long userId = long.Parse(uxUserId.Text);
CommunityGroupManager communityGroupManager = new CommunityGroupManager();
Boolean isUserInGroup = communityGroupManager.IsUserInGroup(userId, communityGroupId);
MessageUtilities.UpdateMessage(uxMessage, "Is User with ID " + userId + " present in in Community Group with ID " + communityGroupId + " : " + isUserInGroup, Message.DisplayModes.Success);
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
RemoveUser. Removes a user from a community group.
RemoveUser
RemoveUser(System.Int64,System.Int64)
Removes a user from a community 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
- * Community Group ID
- * User ID
Parameters
communityGroupId. ID of the community group.userId. ID of the user.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxCommunityGroupIdLabel" AssociatedControlID="uxCommunityGroupId" CssClass="span-4 last" runat="server" Text="* Community Group Id :" />
<ektronUI:TextField ID="uxCommunityGroupId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
</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-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="10005" />
</li>
<li class="clearfix">
<ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Remove User"></ektronUI:Button>
<ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
</li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using Ektron.Cms.Framework.Community;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
long communityGroupId = long.Parse(uxCommunityGroupId.Text);
long userId = long.Parse(uxUserId.Text);
CommunityGroupManager communityGroupManager = new CommunityGroupManager();
communityGroupManager.RemoveUser(communityGroupId, userId);
MessageUtilities.UpdateMessage(uxMessage, "User with ID " + userId + " removed from Community Group with ID " + communityGroupId, Message.DisplayModes.Success);
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
RequestJoin. Creates a request to join a community group.
RequestJoin
RequestJoin(System.Int64,System.Int64)
Creates a request to join a community 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
- * Community Group ID
- * User ID
Parameters
communityGroupId. ID of the community group.userId. ID of the user.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="Label1" AssociatedControlID="uxCommunityGroupId" CssClass="span-4 last" runat="server" Text="* Community Group Id :" />
<ektronUI:TextField ID="TextField1" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="1" />
</li>
<li class="clearfix">
<ektronUI:Label ID="Label2" AssociatedControlID="uxUserId" CssClass="span-4 last" runat="server" Text="* User Id :" />
<ektronUI:TextField ID="TextField2" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Text="8" />
</li>
<li class="clearfix">
<ektronUI:Button id="Button1" runat="server" OnClick="uxSubmit_Click" Text="Request Join"></ektronUI:Button>
<ektronUI:Label ID="Label3" CssClass="span-4" runat="server" Text="* - Required" />
</li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using Ektron.Cms.Framework.Community;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
long communityGroupId = long.Parse(uxCommunityGroupId.Text);
long userId = long.Parse(uxUserId.Text);
CommunityGroupManager communityGroupManager = new CommunityGroupManager();
communityGroupManager.RequestJoin(communityGroupId, userId);
MessageUtilities.UpdateMessage(uxMessage, "User with Id " + userId + " requested to join ", Message.DisplayModes.Success);
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
Update. Updates an existing community group.
Update
Update(Ektron.Cms.CommunityGroupData)
Updates an existing community group 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
- * Group ID
- Group Name
- Enable Distribute
- Enable Group Mail
- Short Description
- Long Description
Parameters
communityGroupData. The CommunityGroupData object to update.
Returns
Returns the custom CommunityGroupData object that was updated.
Remarks
Validate the community group item with GetItem() before you update the properties. Then, call Update with your modified CommunityGroupData object.
NOTE: You cannot change all properties after the initial Add event, such as the CommunityGroupData.Type.
.aspx code snippet
<ol class="formFields">
<li class="clearfix">
<ektronUI:Label ID="uxCommunityGroupIdLabel" AssociatedControlID="uxCommunityGroupId" CssClass="span-4 last" runat="server" Text="* Group Id:" />
<ektronUI:TextField ID="uxCommunityGroupId" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxGroupNameLabel" AssociatedControlID="uxGroupName" CssClass="span-4 last" runat="server" Text=" Group Name:" />
<ektronUI:TextField ID="uxGroupName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxGroupEnableDistributeLabel" AssociatedControlID="uxGroupEnableDistribute" CssClass="span-4 last" runat="server" Text="Group Enable Distribute:" />
<asp:checkbox ID="uxGroupEnableDistribute" runat="server" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxEnableGroupEmailsLabel" AssociatedControlID="uxEnableGroupEmails" CssClass="span-4 last" runat="server" Text=" Enable Group Email:" />
<asp:checkbox ID="uxEnableGroupEmails" runat="server" AutoPostBack="true" OnCheckedChanged="uxEnableGroupEmails_OnCheckedChanged" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxEmailAccountNameLabel" AssociatedControlID="uxEmailAccountName" CssClass="span-4 last" runat="server" Text="Email Account Name:" Enabled="false" />
<ektronUI:TextField ID="uxEmailAccountName" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Enabled="false" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxEmailAddressLabel" AssociatedControlID="uxEmailAddress" CssClass="span-4 last" runat="server" Text="Email Address:" Enabled="false" />
<ektronUI:TextField ID="uxEmailAddress" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Enabled="false" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxEmailPasswordLabel" AssociatedControlID="uxEmailPassword" CssClass="span-4 last" runat="server" Text="Email Password:" Enabled="false" />
<ektronUI:TextField ID="uxEmailPassword" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" Enabled="false" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxGroupImageLabel" AssociatedControlID="uxGroupImage" CssClass="span-4 last" runat="server" Text="Group Image:" />
<asp:FileUpload ID="uxGroupImage" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" size="29.75" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxGroupAdminLabel" AssociatedControlID="uxGroupAdmin" CssClass="span-4 last" runat="server" Text="Group Admin Id:" />
<ektronUI:TextField ID="uxGroupAdmin" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxGroupShortDescriptionLabel" AssociatedControlID="uxGroupShortDescription" CssClass="span-4 last" runat="server" Text="Short Description:" />
<ektronUI:TextField ID="uxGroupShortDescription" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxGroupLongDescriptionLabel" AssociatedControlID="uxGroupLongDescription" CssClass="span-4 last" runat="server" Text="Long Description:" />
<asp:TextBox TextMode="MultiLine" Rows="3" ID="uxGroupLongDescription" CssClass="span-6" runat="server" ValidationGroup="RegisterValidationGroup" />
</li>
<li class="clearfix">
<ektronUI:Label ID="uxRequiredLabel" CssClass="span-4 last" runat="server" Text="* - Required" />
<ektronUI:Button id="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Update"></ektronUI:Button>
</li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
.aspx.cs code-behind namespace
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using Ektron.Cms; using Ektron.Storage; using Microsoft.VisualBasic; using Ektron.Cms.Framework.User; using Ektron.Cms.Framework.Community;
.aspx.cs code-behind method
protected void uxSubmit_Click(object sender, EventArgs e)
{
try
{
long communityGroupId;
long.TryParse(uxCommunityGroupId.Text, out communityGroupId);
if (communityGroupId != 0)
{
CommunityGroupManager communityGroupManager = new CommunityGroupManager();
CommunityGroupData communityGroupData = communityGroupManager.GetItem(communityGroupId);
if (communityGroupData != null)
{
communityGroupData.Name = uxGroupName.Text != string.Empty ? uxGroupName.Text : communityGroupData.Name;
communityGroupData.EnableDistributeToSite = uxGroupEnableDistribute.Checked == true ? uxGroupEnableDistribute.Checked : communityGroupData.EnableDistributeToSite;
communityGroupData.LongDescription = uxGroupLongDescription.Text != string.Empty ? uxGroupLongDescription.Text : communityGroupData.LongDescription;
if (uxEnableGroupEmails.Checked == true)
{
if (communityGroupData.EnableGroupEmail == true)
{
communityGroupData.EmailAccountName = uxEmailAccountName.Text != "" ? uxEmailAccountName.Text : communityGroupData.EmailAccountName;
if (uxEmailAddress.Text != "")
{
EmailAddressValidation(uxEmailAddress.Text);
communityGroupData.EmailAddress = uxEmailAddress.Text;
}
communityGroupData.EmailPassword = uxEmailPassword.Text != "" ? uxEmailPassword.Text : communityGroupData.EmailPassword;
}
else
{
if (!String.IsNullOrWhiteSpace(uxEmailAccountName.Text) && !String.IsNullOrWhiteSpace(uxEmailAddress.Text) && !String.IsNullOrWhiteSpace(uxEmailPassword.Text))
{
EmailAddressValidation(uxEmailAddress.Text);
communityGroupData.EmailAccountName = uxEmailAccountName.Text;
communityGroupData.EmailAddress = uxEmailAddress.Text;
communityGroupData.EmailPassword = uxEmailPassword.Text;
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Need valid EmailAddress, EmailPassword, and EmailAccountName when EnableGroupEmail is enabled.", Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
return;
}
}
communityGroupData.EnableGroupEmail = uxEnableGroupEmails.Checked;
}
if (uxGroupImage.HasFile)
{
if ((uxGroupImage.PostedFile.ContentType == "image/pjpeg") || (uxGroupImage.PostedFile.ContentType == "image/jpeg") || (uxGroupImage.PostedFile.ContentType == "image/gif"))
{
string[] fileNameArray = Strings.Split(uxGroupImage.PostedFile.FileName, "\\", -1, 0);
string strFileName = (System.Guid.NewGuid().ToString()).Substring(0, 5) + "_g_" + fileNameArray[(fileNameArray.Length - 1)];
StorageClient.Context.File.UploadStream(uxGroupImage.PostedFile.InputStream, Server.MapPath(communityGroupManager.SitePath + "uploadedimages/" + strFileName));
Utilities.ProcessThumbnail(Server.MapPath(communityGroupManager.SitePath + "uploadedimages/"), strFileName);
communityGroupData.Image = communityGroupManager.SitePath + "uploadedimages/thumb_" + Utilities.GetCorrectThumbnailFileWithExtn(strFileName);
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Not a valid jpeg/gif image.", Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
return;
}
}
if (!string.IsNullOrWhiteSpace(uxGroupAdmin.Text))
{
long groupAdminId;
long.TryParse(uxGroupAdmin.Text, out groupAdminId);
UserManager Usermanager = new UserManager();
UserData userBaseData = Usermanager.GetItem(groupAdminId);
List<UserData> userList = new List<UserData>();
if (userBaseData != null && userBaseData.Id != 0)
{
userList.Add(userBaseData);
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Please enter valid Group Admin Id.", Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
return;
}
communityGroupData.Admins = userList;
}
if (!string.IsNullOrWhiteSpace(uxGroupShortDescription.Text))
{
if (uxGroupShortDescription.Text.Length > 100)
{
MessageUtilities.UpdateMessage(uxMessage, "Short Description should not exceed 100 characters.", Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
return;
}
communityGroupData.ShortDescription = uxGroupShortDescription.Text;
}
communityGroupManager.Update(communityGroupData);
MessageUtilities.UpdateMessage(uxMessage, "Community group with Id " + communityGroupData.Id + " updated.", Message.DisplayModes.Success);
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Community group does not exist for given Group Id.", Message.DisplayModes.Error);
}
}
else
{
MessageUtilities.UpdateMessage(uxMessage, "Please enter valid Community Group Id.", Message.DisplayModes.Error);
}
uxPageMultiView.SetActiveView(uxViewMessage);
}
catch (Exception ex)
{
MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
uxPageMultiView.SetActiveView(uxViewMessage);
}
}
Data classes
Data Classes
CommunityGroupCriteria
CommunityGroupCriteria
Namespace
Ektron.Cms.Community
Constructors
CommunityGroupCriteria()public CommunityGroupCriteria()
CommunityGroupCriteria(Ektron.Cms.CommunityGroupProperty, EkEnumeration.OrderByDirection)public CommunityGroupCriteria(Ektron.Cms.CommunityGroupProperty orderByField, EkEnumeration.OrderByDirection orderByDirection)
Accepted fields for the
CommunityGroupPropertyare:- AdminId
- CreatedUser
- DateCreated
- DateModified
- EnableCalendar
- EnableDiscussionBoard
- EnableDistribute
- EnableDocumentsInNotifications
- EnableGroupEmail
- EnableMembersManageFolders
- EnableTodoList
- Enroll
- FolderId
- GroupEnroll
- GroupId
- GroupImage
- GroupLevel
- GroupLocation
- GroupName
- GroupParentId
- GroupPath
- Id
- Image
- Level
- Location
- LongDescription
- Name
- ParentId
- Path
- ShortDescription
Properties
ReturnAdminListpublic bool ReturnAdminList { set; get; }
CommunityGroupData
CommunityGroupData
Namespace
Ektron.Cms
Properties
Adminpublic Ektron.Cms.UserBaseData Admin { set; get; }Adminspublic System.Collections.Generic.List<UserData> Admins { set; get; }AllowMemberstoManageFolderspublic bool AllowMembersToManageFolders { set; get; }Categorypublic string Category { set; get; }CreatedDatepublic System.DateTime CreatedDate { set; get; }CreatedUserpublic long CreatedUser { set; get; }EmailAccountName. Email Account name assigned to community group. This is required for checking group email.public string EmailAccountName { set; get; }EmailAddress. Email address assigned to Community Group.public string EmailAddress { set; get; }EmailPassword. Password for email account assigned to community group. This is required for checking group email.public string EmailPassword { set; get; }EnableCalendarpublic bool EnableCalendar { set; get; }EnableDiscussionBoardpublic bool EnableDiscussionBoard { set; get; }EnableDistributeToSitepublic bool EnableDistributeToSite { set; get; }EnableDocumentsInNotifications. If true, all notification emails on asset types will have the asset added as an attachment.public bool EnableDocumentsInNotifications { set; get; }EnableGroupEmail. If true, the community group will accept email using the email address.public bool EnableGroupEmail { set; get; }EnableTodoListpublic bool EnableTodoList { set; get; }Enrollpublic bool Enroll { set; get; }FolderIdpublic long FolderId { set; get; }GroupAdminpublic Ektron.Cms.UserBaseData GroupAdmin { set; get; }GroupCategorypublic string GroupCategory { set; get; }GroupCreatedDatepublic System.DateTime GroupCreatedDate { set; get; }GroupEnableDistributeToSitepublic bool GroupEnableDistributeToSite { set; get; }GroupEnrollpublic bool GroupEnroll { set; get; }GroupHiddenpublic bool GroupHidden { set; get; }GroupId. This property is obsolete in 8.5. Use Id.public long GroupId { set; get; }GroupImagepublic string GroupImage { set; get; }GroupLevelpublic int GroupLevel { set; get; }GroupLocationpublic string GroupLocation { set; get; }GroupLongDescriptionpublic string GroupLongDescription { set; get; }GroupNamepublic string GroupName { set; get; }GroupParentIdpublic long GroupParentId { set; get; }GroupPathpublic string GroupPath { set; get; }GroupShortDescriptionpublic string GroupShortDescription { set; get; }HasSubGrouppublic bool HasSubGroup { set; get; }Hiddenpublic bool Hidden { set; get; }Idpublic override long Id { set; get; }Imagepublic string Image { set; get; }Levelpublic int Level { set; get; }Locationpublic string Location { set; get; }LongDescriptionpublic string LongDescription { set; get; }Namepublic string Name { set; get; }ParentIdpublic long ParentId { set; get; }Pathpublic string Path { set; get; }ShortDescriptionpublic string ShortDescription { set; get; }Tags. This property is read-only and any changes will not be saved. To add tags to a CommunityGroup, use theAddTagToCommunityGroupAPI.public string Tags { set; get; }TotalMember. Gets the total number of member sin the community group. This property is read-only and will not be persisted on Add or Update.public int TotalMember { set; get; }ToXmlString()public string ToXmlString()