Class SiteSecurity
Domain Object that is used in the site template
Inherited Members
Namespace: PnP.Framework.Provisioning.Model
Assembly: PnP.Framework.dll
Syntax
public class SiteSecurity : BaseModel, IProvisioningTemplateDescendant
Constructors
SiteSecurity()
Constructor for SiteSecurity class
Declaration
public SiteSecurity()
Properties
AdditionalAdministrators
A Collection of users that are associated as site collection adminsitrators
Declaration
public UserCollection AdditionalAdministrators { get; }
Property Value
UserCollection
|
AdditionalMembers
A Collection of users that are associated to the sites members group
Declaration
public UserCollection AdditionalMembers { get; }
Property Value
UserCollection
|
AdditionalOwners
A Collection of users that are associated to the sites owners group
Declaration
public UserCollection AdditionalOwners { get; }
Property Value
UserCollection
|
AdditionalVisitors
A Collection of users taht are associated to the sites visitors group
Declaration
public UserCollection AdditionalVisitors { get; }
Property Value
UserCollection
|
AssociatedGroups
Specifies the list of groups that are associated with the Web site. Groups in this list will appear under the Groups section in the People and Groups page.
Declaration
public String AssociatedGroups { get; set; }
Property Value
String
|
AssociatedMemberGroup
Specifies the default members group for this site. The group will automatically be added to the top of the Associated Groups list.
Declaration
public String AssociatedMemberGroup { get; set; }
Property Value
String
|
AssociatedOwnerGroup
Specifies the default owners group for this site. The group will automatically be added to the end of the Associated Groups list.
Declaration
public String AssociatedOwnerGroup { get; set; }
Property Value
String
|
AssociatedVisitorGroup
Specifies the default visitors group for this site. The group will automatically be added to the end of the Associated Groups list.
Declaration
public String AssociatedVisitorGroup { get; set; }
Property Value
String
|
BreakRoleInheritance
Declares whether the to break role inheritance for the site, if it is a sub-site
Declaration
public Boolean BreakRoleInheritance { get; set; }
Property Value
Boolean
|
ClearExistingAdministrators
Declares whether to clear existing administrators before adding new ones
Declaration
public Boolean ClearExistingAdministrators { get; set; }
Property Value
Boolean
|
ClearExistingMembers
Declares whether to clear existing members before adding new ones
Declaration
public Boolean ClearExistingMembers { get; set; }
Property Value
Boolean
|
ClearExistingOwners
Declares whether to clear existing owners before adding new ones
Declaration
public Boolean ClearExistingOwners { get; set; }
Property Value
Boolean
|
ClearExistingVisitors
Declares whether to clear existing visitors before adding new ones
Declaration
public Boolean ClearExistingVisitors { get; set; }
Property Value
Boolean
|
ClearSubscopes
Defines whether to clear subscopes or not while breaking role inheritance for the site
Declaration
public Boolean ClearSubscopes { get; set; }
Property Value
Boolean
|
CopyRoleAssignments
Defines whether to copy role assignments or not while breaking role inheritance
Declaration
public Boolean CopyRoleAssignments { get; set; }
Property Value
Boolean
|
RemoveExistingUniqueRoleAssignments
Defines whether to remove unique role assignments or not if the site already breaks role inheritance. If true all existing unique role assignments on the site will be removed if BreakRoleInheritance also is true.
Declaration
public Boolean RemoveExistingUniqueRoleAssignments { get; set; }
Property Value
Boolean
|
ResetRoleInheritance
Declares whether to reset the role inheritance or not for the site, if it is a sub-site
Declaration
public Boolean ResetRoleInheritance { get; set; }
Property Value
Boolean
|
SiteGroups
List of additional Groups for the Site
Declaration
public SiteGroupCollection SiteGroups { get; }
Property Value
SiteGroupCollection
|
SiteSecurityPermissions
List of Site Security Permissions for the Site
Declaration
public SiteSecurityPermissions SiteSecurityPermissions { get; }
Property Value
SiteSecurityPermissions
|
Methods
Equals(SiteSecurity)
Compares SiteSecurity object based on AdditionalAdministrators, AdditionalOwners, AdditionalMembers, AdditionalVisitors, SiteGroups, SiteSecurityPermissions, BreakRoleInheritance, CopyRoleAssignments and ClearSubscopes properties.
Declaration
public bool Equals(SiteSecurity other)
Parameters
SiteSecurity
other
SiteSecurity object |
Returns
System.Boolean
true if the SiteSecurity object is equal to the current object; otherwise, false. |
Equals(Object)
Compares object with SiteSecurity
Declaration
public override bool Equals(object obj)
Parameters
System.Object
obj
Object that represents SiteSecurity |
Returns
System.Boolean
true if the current object is equal to the SiteSecurity |
GetHashCode()
Gets the hash code
Declaration
public override int GetHashCode()
Returns
System.Int32
Returns HashCode |