Table of Contents

Class Site

Namespace
Oqtane.Models
Assembly
Oqtane.Shared.dll

Describes a Site in a Tenant in an Oqtane installation. Sites can have multiple Aliases.

public class Site : ModelBase, IAuditable, IDeletable
Inheritance
Site
Implements
Inherited Members

Properties

AdminContainerType

Default admin container

public string AdminContainerType { get; set; }

Property Value

string

AllowRegistration

Determines if visitors may register / create user accounts

public bool AllowRegistration { get; set; }

Property Value

bool

BodyContent

Content to be included in the body of the page

public string BodyContent { get; set; }

Property Value

string

CaptureBrokenUrls

Determines if broken urls (404s) will be captured automatically

public bool CaptureBrokenUrls { get; set; }

Property Value

bool

DefaultContainerType

Default container for the site

public string DefaultContainerType { get; set; }

Property Value

string

DefaultLayoutType

[NotMapped]
[Obsolete("This property is deprecated.", false)]
public string DefaultLayoutType { get; set; }

Property Value

string

DefaultThemeType

Default theme for the site

public string DefaultThemeType { get; set; }

Property Value

string

DeletedBy

The user who deleted site

public string DeletedBy { get; set; }

Property Value

string

DeletedOn

Date site was deleted

public DateTime? DeletedOn { get; set; }

Property Value

DateTime?

FaviconFileId

Reference to a File which has the FavIcon for this site. Should be an image. The theme can then use this where needed.

public int? FaviconFileId { get; set; }

Property Value

int?

HeadContent

Content to be included in the head of the page

public string HeadContent { get; set; }

Property Value

string

HomePageId

The home page of the site - the "/" path will be used by default if no home page is specified

public int? HomePageId { get; set; }

Property Value

int?

Hybrid

Indicates if a site can be integrated with an external .NET MAUI hybrid application

public bool Hybrid { get; set; }

Property Value

bool

ImageFiles

The allowable iamge file extensions

[NotMapped]
public string ImageFiles { get; set; }

Property Value

string

IsDeleted

Indicates if site is deleted

public bool IsDeleted { get; set; }

Property Value

bool

Languages

List of languages for the site

[NotMapped]
public List<Language> Languages { get; set; }

Property Value

List<Language>

LogoFileId

Reference to a File which has the Logo for this site. Should be an image. The theme can then use this where needed.

public int? LogoFileId { get; set; }

Property Value

int?

Name

The site Name

public string Name { get; set; }

Property Value

string

Pages

List of pages for the site

[NotMapped]
public List<Page> Pages { get; set; }

Property Value

List<Page>

Prerender

If the site supports prerendering (only applies to Interactive rendermode)

public bool Prerender { get; set; }

Property Value

bool

PwaAppIconFileId

The app icon for the progressive web application (PWA)

public int? PwaAppIconFileId { get; set; }

Property Value

int?

PwaIsEnabled

Indicates if the site is a progressive web application (PWA)

public bool PwaIsEnabled { get; set; }

Property Value

bool

PwaSplashIconFileId

The splash icon for the progressive web application (PWA)

public int? PwaSplashIconFileId { get; set; }

Property Value

int?

RenderMode

The default render mode for the site ie. Static,Interactive,Headless

public string RenderMode { get; set; }

Property Value

string

Runtime

The render mode for UI components which require interactivity ie. Server,WebAssembly,Auto

public string Runtime { get; set; }

Property Value

string

Settings

The settings for the site

[NotMapped]
public Dictionary<string, string> Settings { get; set; }

Property Value

Dictionary<string, string>

SiteGuid

Unique GUID to identify the Site.

public string SiteGuid { get; set; }

Property Value

string

SiteId

The ID of the Site

public int SiteId { get; set; }

Property Value

int

SiteTemplateType

Used when provisioning a site from a site template

[NotMapped]
public string SiteTemplateType { get; set; }

Property Value

string

TenantId

Reference to the Tenant the Site is in

public int TenantId { get; set; }

Property Value

int

Themes

List of themes for the site

[NotMapped]
public List<Theme> Themes { get; set; }

Property Value

List<Theme>

UploadableFiles

The allowable file extensions which can be uploaded

[NotMapped]
public string UploadableFiles { get; set; }

Property Value

string

Version

Keeps track of site configuration changes and is used by the ISiteMigration interface

public string Version { get; set; }

Property Value

string

VisitorTracking

Determines if site visitors will be recorded

public bool VisitorTracking { get; set; }

Property Value

bool

Methods

Clone()

public Site Clone()

Returns

Site