Ektron.Cms.Framework.Community.CommunityGroupManager

Community Group Manager

Properties
ApiMode Gets or sets the current API access mode. If set to Admin, the API runs with the permissions of an administrator.
CommunityGroupManagerService returns an instance of the business objects task manager service.
ContentLanguage Gets or sets the current content language.
InPreviewMode Gets or sets the current Preview Mode. Returns true if the site is in site preview mode.
RequestInformation Gets the current Request Information.
SitePath Gets the site path.
UserId Gets or sets the currently logged in user ID.
Method Description
CommunityGroupManager constructor
CommunityGroupManager(ApiAccessMode) constructor
Add(CommunityGroupData) Adds a new CommunityGroup, with details from the supplied CommunityGroupData object.
Update(CommunityGroupData) Updates a CommunityGroup, with details from the supplied CommunityGroupData object.
Delete(Int64) Deletes an existing CommunityGroup.
GetItem(Int64) Returns details of a CommunityGroup.
GetList(CommunityGroupCriteria) Returns a list of CommunityGroups that fit the supplied criteria.
GetUserList(Int64) Returns a list of DirectoryUsers that fit the communityGroupId.
IsUserInGroup(Int64,Int64) Determines if the user is in the group
GetBlogId(Int64) Gets the blog id of the communityGroup
GetFolderId(Int64) Gets the folder id of the communityGroup
GetCalendarId(Int64) Gets the calendar id of the communityGroup
GetDiscussionBoardId(Int64) Gets the discussionBoard id of the communityGroup
GetTaxonomyId(Int64) Gets the taxonomy id of the communityGroup
AddUser(Int64,Int64) Adds a user to a communityGroup
RemoveUser(Int64,Int64) Removes a user from a Community Group
GetMemberStatus(Int64,Int64) Gets the member status of the user in the communityGroup
Invite(Int64,Int64) Invites a user to a communityGroup
Invite(Int64,String) Invites a email to a communityGroup
RequestJoin(Int64,Int64) Requests a join to a user
AcceptInvite(Int64,Int64) Accepts an invitation of a communityGroup
DeclineInvite(Int64,Int64) Declines an invitation of a communityGroup
GetAdminList(Int64) Get the list of admin users for a communityGroup
ApproveJoin(Int64,Int64) Accepts a user join request for community group
DeclineJoin(Int64,Int64) Decline a user join request for community group