Class SiteCollection

Inheritance
System.Object
BaseHierarchyModel
SiteCollection
ClassicSiteCollection
CommunicationSiteCollection
TeamNoGroupSiteCollection
TeamSiteCollection
Inherited Members
Namespace: PnP.Framework.Provisioning.Model
Assembly: PnP.Framework.dll
Syntax
public abstract class SiteCollection : BaseHierarchyModel, IProvisioningHierarchyDescendant

Constructors

SiteCollection()

Declaration
public SiteCollection()

Properties

Description

Description of the site

Declaration
public string Description { get; set; }
Property Value
System.String

HubSiteLogoUrl

Defines the url to the logo if this site is a hubsite. Only applicable if IsHubSite is set to true.

Declaration
public string HubSiteLogoUrl { get; set; }
Property Value
System.String

HubSiteTitle

Defines the url to the logo if this site is a hubsite. Only applicable if IsHubSite is set to true.

Declaration
public string HubSiteTitle { get; set; }
Property Value
System.String

Id

Internal use only

Declaration
public Guid Id { get; }
Property Value
Guid

IsHubSite

Declares whether the current Site Collection is the Hub Site of a new Hub

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

ProvisioningId

Defines an optional ID in the sequence for use in tokens.

Declaration
public string ProvisioningId { get; set; }
Property Value
System.String

Sites

Defines the list of sub-sites, if any

Declaration
public SubSiteCollection Sites { get; }
Property Value
SubSiteCollection

Templates

Defines the list of Provisioning Templates to apply to the site collection, if any

Declaration
public List<string> Templates { get; }
Property Value
List<System.String>

Theme

Defines the Theme to apply to the SiteCollection

Declaration
public string Theme { get; set; }
Property Value
System.String

Title

Title of the site

Declaration
public string Title { get; set; }
Property Value
System.String

Methods

Equals(SiteCollection)

Compares SiteCollection object based on its properties

Declaration
public bool Equals(SiteCollection other)
Parameters
SiteCollection other

SiteCollection object
Returns
System.Boolean

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

Equals(Object)

Compares object with SiteCollection

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

Object that represents SiteCollection
Returns
System.Boolean

true if the current object is equal to the SiteCollection

EqualsInherited(SiteCollection)

Compares the HashCode of the members of any inherited type

Declaration
protected abstract bool EqualsInherited(SiteCollection other)
Parameters
SiteCollection other

Returns
System.Boolean

GetHashCode()

Gets the hash code

Declaration
public override int GetHashCode()
Returns
System.Int32

Returns HashCode

GetInheritedHashCode()

Returns the HashCode of the members of any inherited type

Declaration
protected abstract int GetInheritedHashCode()
Returns
System.Int32

ToString()

Declaration
public override string ToString()
Returns
System.String

Extension Methods