Group Class
Represents a group on a Microsoft SharePoint Foundation Web site.
Inheritance Hierarchy
System.Object
Microsoft.SharePoint.Client.ClientObject
Microsoft.SharePoint.Client.Principal
Microsoft.SharePoint.Client.Group
Namespace: Microsoft.SharePoint.Client
Assemblies: Microsoft.SharePoint.Client.Silverlight (in Microsoft.SharePoint.Client.Silverlight.dll); Microsoft.SharePoint.Client (in Microsoft.SharePoint.Client.dll)
Syntax
'Declaration
<ScriptTypeAttribute("SP.Group", ServerTypeId := "{e54ad5f1-ce4e-453b-b7f7-aea6556c9c40}")> _
Public Class Group _
Inherits Principal
'Usage
Dim instance As Group
[ScriptTypeAttribute("SP.Group", ServerTypeId = "{e54ad5f1-ce4e-453b-b7f7-aea6556c9c40}")]
public class Group : Principal
Remarks
Group represents a collection of users. Every group can be represented by an SPMember object and has a unique member identifier.
Examples
This code example adds the current user to the visitors group on the current site.
using System;
using Microsoft.SharePoint.Client;
namespace Microsoft.SDK.SharePointFoundation.Samples
{
class GroupExample
{
static void Main()
{
string siteUrl = "http://MyServer/sites/MySiteCollection";
ClientContext clientContext = new ClientContext(siteUrl);
Web site = clientContext.Web;
GroupCollection collGroup = site.SiteGroups;
// Get the visitors group, assuming its ID is 4.
Group visitorsGroup = collGroup.GetById(4);
User currentUser = site.CurrentUser;
UserCollection collUser = visitorsGroup.Users;
collUser.AddUser(currentUser);
clientContext.Load(currentUser);
clientContext.Load(visitorsGroup);
clientContext.ExecuteQuery();
Console.WriteLine(currentUser.Title + " added to group " + visitorsGroup.Title);
}
}
}
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.