Class SiteGroup

The base type for a Site Group

Inheritance
System.Object
BaseModel
SiteGroup
Inherited Members
Namespace: PnP.Framework.Provisioning.Model
Assembly: PnP.Framework.dll
Syntax
public class SiteGroup : BaseModel, IProvisioningTemplateDescendant

Constructors

SiteGroup()

Constructor for SiteGroup class

Declaration
public SiteGroup()

SiteGroup(IEnumerable<User>)

Constructor for SiteGroup class

Declaration
public SiteGroup(IEnumerable<User> members)
Parameters
IEnumerable<User> members

SiteGroup members

Properties

AllowMembersEditMembership

Defines whether the members can edit membership of the Site Group

Declaration
public Boolean AllowMembersEditMembership { get; set; }
Property Value
Boolean

AllowRequestToJoinLeave

Defines whether to allow requests to join or leave the Site Group

Declaration
public Boolean AllowRequestToJoinLeave { get; set; }
Property Value
Boolean

AutoAcceptRequestToJoinLeave

Defines whether to auto-accept requests to join or leave the Site Group

Declaration
public Boolean AutoAcceptRequestToJoinLeave { get; set; }
Property Value
Boolean

ClearExistingMembers

True to clear members of the group

Declaration
public Boolean ClearExistingMembers { get; set; }
Property Value
Boolean

Description

The Description of the Site Group

Declaration
public String Description { get; set; }
Property Value
String

Members

The list of members of the Site Group

Declaration
public UserCollection Members { get; }
Property Value
UserCollection

OnlyAllowMembersViewMembership

Defines whether to allow members only to view the membership of the Site Group

Declaration
public Boolean OnlyAllowMembersViewMembership { get; set; }
Property Value
Boolean

Owner

The Owner of the Site Group

Declaration
public String Owner { get; set; }
Property Value
String

RequestToJoinLeaveEmailSetting

Defines the email address used for membership requests to join or leave will be sent for the Site Group

Declaration
public String RequestToJoinLeaveEmailSetting { get; set; }
Property Value
String

Title

The Title of the Site Group

Declaration
public String Title { get; set; }
Property Value
String

Methods

Equals(SiteGroup)

Compares SiteGroup object based on AllowMembersEditMembership, AllowRequestToJoinLeave, AutoAcceptRequestToJoinLeave, Description, Members, OnlyAllowMembersViewMembership, Owner, RequestToJoinLeaveEmailSetting and Title properties.

Declaration
public bool Equals(SiteGroup other)
Parameters
SiteGroup other

SiteGroup object
Returns
System.Boolean

true if the SiteGroup object is equal to the current object; otherwise, false.

Equals(Object)

Compares object with SiteGroup

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

Object that represents SiteGroup
Returns
System.Boolean

true if the current object is equal to the SiteGroup

GetHashCode()

Gets the hash code

Declaration
public override int GetHashCode()
Returns
System.Int32

Returns HashCode

Extension Methods