Group Class

Definition

Represents the top-level container in a TermStore object.

public ref class Group sealed : Microsoft::SharePoint::Taxonomy::TaxonomyItem
[Microsoft.SharePoint.Client.ClientCallableType(ClientLibraryTargets=Microsoft.SharePoint.Client.ClientLibraryTargets.NonRESTful, FactoryType=typeof(Microsoft.SharePoint.Taxonomy.Internal.TaxonomyClientObjectFactory), Name="TermGroup", ObjectIdentityPropertyName="CanonicalId", ServerTypeId="65D76872-0B65-42de-8EBD-D76F6D3491C6")]
public sealed class Group : Microsoft.SharePoint.Taxonomy.TaxonomyItem
type Group = class
    inherit TaxonomyItem
Public NotInheritable Class Group
Inherits TaxonomyItem
Inheritance
Attributes
ClientCallableTypeAttribute

Remarks

The object contains one or more child TermSet instances, and these can be accessed through the TermSets property. The Group class also provides methods for creating new child TermSet objects.Permissions for editing child Term and TermSet instances is specified on the group. The Group class provides methods for getting and setting permissions on the group, and for checking permissions.

The Group class also provides properties to get and set values of the Group object such as name and description, and enables the deletion of groups.

Additionally the Group class provides methods for checking changes on the Group object.

The Group class derives from the TaxonomyItem base class which provides additional properties such as Id and TermStore

Properties

Contributors

Returns the SPAcl indicating the users who are contributors to the current Group object.

CreatedDate

Gets the DateTime at which this item was created.

(Inherited from TaxonomyItem)
Description

Gets or sets the description of this Group object

GroupManagers

Returns the SPAcl indicating the users who are group managers for this Group object.

Id

Gets the Id of the current T:Microsoft.SharePoint.Taxonomy.TaxonomyItem.

(Inherited from TaxonomyItem)
IsReadOnlySiteCollectionGroup

Gets a Boolean value that is true if the group for the current site is a read-only site collection group; otherwise, false

IsSiteCollectionGroup

Gets whether this Group object is a site collection Group.

IsSystemGroup

Gets whether this Group object is the system Group.

LastModifiedDate

Gets the DateTime at which this item was most recently updated.

(Inherited from TaxonomyItem)
Name

Gets or sets the name of this Group object.

SiteCollectionAccessIds

Gets a list of SPSite IDs that have access to the local site collection group.

SiteCollectionReadOnlyAccessUrls

Gets a list of URLs of site collections that have read-only access.

TermSets

Gets a collection of the child TermSet instances of this Group

TermStore

Gets the TermStore object from which the current Microsoft.SharePoint.TaxonomyItem was retrieved.

(Inherited from TaxonomyItem)

Methods

AddContributor(String)

Adds a contributor to the Group object.

AddGroupManager(String)

Adds a group manager to the Group object.

AddSiteCollectionAccess(Guid)

Adds a site collection to have access to its local site collection group.

AddSiteCollectionReadOnlyAccess(String)

Adds a site collection to have read-only access to this local site collection group.

ClearSiteCollectionReadOnlyAccess()

Removes all site collection read-only access to this local site collection group.

CreateTermSet(String)

Creates a new Microsoft.SharePoint.TaxonomyTermSet object in this Group object by using the term store working language.

CreateTermSet(String, Guid)

Creates a new T:Microsoft.SharePoint.Taxonomy.TermSet object in this T:Microsoft.SharePoint.Taxonomy.Group object by using the working language of the TermStore object and the specified unique identifier.

CreateTermSet(String, Guid, Int32)

Creates a new TermSet object in the current Group object by using the provided language and the specified unique identifier.

CreateTermSet(String, Int32)

Creates a new TermSet object in the current Group object by using the provided language.

Delete()

Deletes this Group from the TermStore object.

DeleteContributor(String)

Deletes a contributor from the Group object.

DeleteGroupManager(String)

Deletes a group manager from the Group object.

DeleteSiteCollectionAccess(Guid)

Removes site collection access to local site collection group.

DeleteSiteCollectionReadOnlyAccess(String)

Removes a site collection from having read-only access to this local site collection group.

DoesUserHavePermissions(TaxonomyRights)

Checks whether the current user has the permissions specified.

Export()

This method is not implemented.

GetChanges(DateTime)

Gets a collection of ChangedItem objects that represent changes to this Group since a specified time.

GetChanges(DateTime, ChangedItemType)

Gets a collection of ChangedItem instances that represent changes to the current Group object since a specified time, restricted by item type.

GetChanges(DateTime, ChangedItemType, ChangedOperationType)

Gets a collection of ChangedItem objects that represent changes to this Group object since a specified time, restricted by item type and operation type.

GetEffectivePermissions()

Gets the TaxonomyRights permissions of the current user in this Group object

GetTermSetsWithCustomProperty(String)

Searches TermSet objects that have a custom property with the specified name in the Group object.

GetTermSetsWithCustomProperty(String, String)

Searches TermSet objects that have a custom property with the specified name and value in the Group object.

GetTermSetsWithCustomProperty(String, String, StringMatchOption)

Searches TermSet objects that have a custom property with the specified name and value in the Group object.

GetTermSetsWithCustomProperty(String, String, StringMatchOption, Int32)

Searches TermSet objects that have a custom property with the specified name and value in the Group object.

Applies to