You are here: Ektron Namespace > Web Services API > Ektron.Services Namespace > Classes > CommunityGroup Class
Ektron CMS400.NET API Documentation
ContentsIndexHome
PreviousUpNext
CommunityGroup Class

This section describes the Web Service methods used with Ektron's Community Groups. The Community Groups Web service is a wrapper for the Community Groups API: Ektron.Cms.API.Community.CommunityGroup. These methods can be accessed through the CommunityGroup.asmx file located in:

~/Workarea/webservices/WebServiceAPI/Community/CommunityGroup.asmx

 

IMPORTANT: If you are accessing these Web Services remotely, you will need to set the authentication header.

C#
public class CommunityGroup : EktronBaseService;
Visual Basic
Public Class CommunityGroup
Inherits EktronBaseService

CommunityGroup.cs

Name 
Description 
The methods of the CommunityGroup class are listed here. 
 
Name 
Description 
 
Saves a new community group.
This method can be accessed through the CommunityGroup.asmx file located in:  
 
This is the overview for the AddUserToCommunityGroup method overload. 
 
Approves the user's pending group request.
This method can be accessed through the CommunityGroup.asmx file located in:  
 
Cancels a community group join request sent by the user.
This method can be accessed through the CommunityGroup.asmx file located in:  
 
Deletes an existing community group.
This method can be accessed through the CommunityGroup.asmx file located in:  
 
Delete or reject a users pending group request.
This method can be accessed through the CommunityGroup.asmx file located in:  
 
Returns an array of Community Groups based upon supplied criteria.
This method can be accessed through the CommunityGroup.asmx file located in:  
 
Retrieves a list of community groups in a Directory.
This method can be accessed through the CommunityGroup.asmx file located in:  
 
Returns a list of users who are not currently in a community group.
This method can be accessed through the CommunityGroup.asmx file located in:  
 
Gets a list of blog IDs that belong to the community group.
This method can be accessed through the CommunityGroup.asmx file located in:  
 
Retrieves a CommunityGroupData object by ID.
This method can be accessed through the CommunityGroup.asmx file located in:  
 
Gets a list of Discussion Board IDs that belong to the community group.
This method can be accessed through the CommunityGroup.asmx file located in:  
 
Gets a list of community groups a user belongs to.
This method can be accessed through the CommunityGroup.asmx file located in:  
 
Gets a list of user IDs that belong to the community group.
This method can be accessed through the CommunityGroup.asmx file located in:  
 
This is the overview for the GetCommunityGroupUsers method overload. 
 
Gets the folder ID used by the Community Group in the CMS content tree.
This method can be accessed through the CommunityGroup.asmx file located in:  
 
Gets the Member status of a user for a particular group.
This method can be accessed through the CommunityGroup.asmx file located in:  
 
Returns a list of Community Groups that a user has been invited to join.
This method can be accessed through the CommunityGroup.asmx file located in:  
 
This is the overview for the GetMostPopularCommunityGroups method overload. 
 
Gets a list of community groups for which the user's membership is pending the Group administrator's approval.
This method can be accessed through the CommunityGroup.asmx file located in:  
 
Returns a list of users whose community group membership is pending approval.
This method can be accessed through the CommunityGroup.asmx file located in:  
 
Invites the users to the community group.
This method can be accessed through the CommunityGroup.asmx file located in:  
 
Returns true if the user is an administrator of the group.
This method can be accessed through the CommunityGroup.asmx file located in:  
 
Returns true if the user is a member of the community group.
This method can be accessed through the CommunityGroup.asmx file located in:  
 
Removes a user from a community group.
This method can be accessed through the CommunityGroup.asmx file located in:  
 
Updates an existing community group.
This method can be accessed through the CommunityGroup.asmx file located in:  
Created with a commercial version of Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at [email protected].
Copyright (c) 2008. All rights reserved.
What do you think about this topic? Send feedback!