MemberGroup MemberGroup MemberGroup Class

Definition

Provides methods and properties to add, delete, retrieve, set, and manage a member group.

public ref class MemberGroup : Microsoft::Office::Server::UserProfiles::ProfileBase, System::Collections::IEnumerable
public class MemberGroup : Microsoft.Office.Server.UserProfiles.ProfileBase, System.Collections.IEnumerable
Public Class MemberGroup
Inherits ProfileBase
Implements IEnumerable
Inheritance
MemberGroupMemberGroupMemberGroup
Implements

Remarks

This class implements the Microsoft .NET Framework IEnumerable interface, which is required for data binding and iterating collections.

A member group represents a list of members of a group, such as the members of a distribution list (DL), the members of a security group, or the members of a SharePoint site.

The MemberGroup object defines a DL or a Windows SharePoint Services site or any other new member group that you create by using the object model. It defines a URL property, which represents the archive location (the mailto: link) in the case of a DL, or a Windows SharePoint Services site URL, in the case of the MemberGroup object.

The SourceReference property is used by the membership source to uniquely reference the group. For example, the membership source unique reference for Microsoft Active Directory is the distinguished name, and for SharePoint sites, is the ID.

The source type of a membership can be a DL, a SharePoint site, or a custom membership source. For more information, see the MembershipSource enumeration.

For more information about types of membership groups, see Memberships Overview. For a code example about how to create a member group and add a member to the newly created group, see How to: Create Memberships.

Fields

m_nMemberCount m_nMemberCount m_nMemberCount

This member is reserved for internal use and is not intended to be used directly from your code.

Properties

Count Count Count

Gets the number of members in a member group.

CurrentChangeToken CurrentChangeToken CurrentChangeToken

Gets the current UserProfileChangeToken object for the change logs of this profile's ProfileType.

(Inherited from ProfileBase)
Description Description Description

Gets or sets the description of a member group.

DisplayName DisplayName DisplayName

Gets or sets the display name of the member group.

Id Id Id

Gets the ID of the member group.

ID ID ID

Gets the GUID for this profile.

(Inherited from ProfileBase)
LastUpdate LastUpdate LastUpdate

Gets the DateTime value of when the member group was last updated.

MailNickName MailNickName MailNickName

Gets or sets the mailing nick name of the member group.

Parent Parent Parent
ProfileManagerBase ProfileManagerBase ProfileManagerBase
ProfileSubtype ProfileSubtype ProfileSubtype

Gets or sets the profile subtype for this property.

(Inherited from ProfileBase)
ProfileSubtypeId ProfileSubtypeId ProfileSubtypeId

Gets or sets the profile subtype ID.

(Inherited from ProfileBase)
ProfileType ProfileType ProfileType
Properties Properties Properties

Gets the ProfileSubtypePropertyManager object for this profile.

(Inherited from ProfileBase)
PublicOrganizationViewUrl PublicOrganizationViewUrl PublicOrganizationViewUrl

Gets the URL of the organization view page for this profile.

(Inherited from ProfileBase)
PublicUrl PublicUrl PublicUrl
RecordId RecordId RecordId

Gets the profile's record identifier.

(Inherited from ProfileBase)
Source Source Source

Gets the membership source for the member group.

SourceInternal SourceInternal SourceInternal

Gets or sets the internal unique identifier.

SourceReference SourceReference SourceReference

Gets or sets the membership source unique reference for the member group.

Url Url Url

Gets or sets the URL of the member group.

ViewerRights ViewerRights ViewerRights

Returns a bitmask of the viewer's rights to see this profile's data.

(Inherited from ProfileBase)

Methods

Commit() Commit() Commit()

Commits changes made to the member group.

Delete() Delete() Delete()

Deletes the member group.

Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is identical to the current profile.

(Inherited from ProfileBase)
GetAllMemberships() GetAllMemberships() GetAllMemberships()

Gets the number of members in a particular member group.

GetChanges() GetChanges() GetChanges()
GetChanges(ProfileBaseChangeQuery) GetChanges(ProfileBaseChangeQuery) GetChanges(ProfileBaseChangeQuery)
GetChanges(UserProfileChangeToken) GetChanges(UserProfileChangeToken) GetChanges(UserProfileChangeToken)
GetEnumerator() GetEnumerator() GetEnumerator()

Returns an enumerator that can iterate through the MemberGroup instance.

GetGroupMembers() GetGroupMembers() GetGroupMembers()
GetHashCode() GetHashCode() GetHashCode()

Returns the hash code for the unique identifier of this profile.

(Inherited from ProfileBase)
GetImmediateMemberships() GetImmediateMemberships() GetImmediateMemberships()
GetProfileValueCollection(String) GetProfileValueCollection(String) GetProfileValueCollection(String)
GetViewerRights() GetViewerRights() GetViewerRights()
IsProfileOwner(UserProfile) IsProfileOwner(UserProfile) IsProfileOwner(UserProfile)
SID() SID() SID()

Gets the profile's unique identifier.

(Inherited from ProfileBase)

Extension Methods

ToJson(Object) ToJson(Object) ToJson(Object)

Applies to