Model Map

CMS Models

Key

	A required field.
	A property on the database.
	Not mapped to the database. These fields are computed and are only available in the object.
	These fields are available where Lava is supported.
	These fields can be used as qualifiers on attributes.
	These methods or fields are obsolete and should not be used.

Model Details

Show: Methods

Site

Site Model Entity. A Site in Rock is a collection of SiteDomains.

Properties

AdditionalLavaFields

AdditionalSettings Gets or sets the additional settings.

AllowedFrameDomains The Allowed Frame Domains designates which external domains/sites are allowed to embed iframes of this site. It controls what is put into the Content-Security-Policy HTTP response header. This is in accordance with the Content Security Policy described here http://w3c.github.io/webappsec-csp/#csp-header and here https://www.owasp.org/index.php/Content_Security_Policy_Cheat_Sheet

AllowIndexing Gets or sets a value indicating whether [allow indexing].

AllowsInteractiveBulkIndexing Gets a value indicating whether [allows interactive bulk indexing].

Attributes

AttributeValueDefaults

AttributeValues

AvailableKeys

Blocks Gets or sets the collection of Blocks that are used on the site.

BotGuardianLevel

Gets or sets the Bot Guardian Level for the Site. This is a hard coded list of values defined in the code as an enumeration.
Show Values

ChangePasswordPage Gets or sets the change password page.

ChangePasswordPageId Gets or sets the change password page identifier.

ChangePasswordPageRoute Gets or sets the change password page route.

ChangePasswordPageRouteId Gets or sets the change password page route identifier.

CommunicationPage Gets or sets the communication page.

CommunicationPageId Gets or sets the communication page identifier.

CommunicationPageRoute Gets or sets the communication page route.

CommunicationPageRouteId Gets or sets the communication page route identifier.

ConfigurationMobilePhoneBinaryFile Gets or sets the configuration mobile phone binary file.

ConfigurationMobilePhoneBinaryFileId Gets or sets the configuration mobile phone binary file identifier.

ConfigurationMobilePhoneFileUrl Gets or sets the configuration mobile file path.

ConfigurationMobileTabletBinaryFile Gets or sets the configuration tablet phone binary file.

ConfigurationMobileTabletBinaryFileId Gets or sets the configuration tablet binary file identifier.

ConfigurationTabletFileUrl Gets or sets the configuration tablet file path.

ContextKey

CreatedByPersonAlias

CreatedByPersonAliasId

CreatedByPersonId

CreatedByPersonName

CreatedDateTime

CustomSortValue

DefaultDomainUri Gets the default domain URI.

DefaultPage Gets or sets the default Page page for the site.

DefaultPageId Gets or sets the Id of the Site's default Page.

DefaultPageRoute Gets or sets the default PageRoute page route for this site. If this value is null, the DefaultPage will be used

DefaultPageRouteId Gets or sets the default page route unique identifier. If this has a value (and the PageRoute can be found) use this instead of the DefaultPageId

Description Gets or sets a user defined description/summary of the Site.

DisablePredictableIds Gets or sets whether predictable Ids are disabled.

EnabledForShortening Gets or sets a value indicating whether this site should be available to be used for shortlinks (the shortlink can still reference the URL of other sites).

EnableExclusiveRoutes Enabling this feature will prevent other sites from using this sites routes and prevent routes from other sites from working on this site.

EnableMobileRedirect Gets or sets a value indicating whether [enable mobile redirect].

EnablePageViewGeoTracking [Obsoleted in v0] Geolocation lookups are now performed on all interactions, regardless of this setting. Gets or sets a value indicating whether geo-location lookups should be performed on interactions.

EnablePageViews Gets or sets a value indicating whether to log Page Views into the Interaction tables for pages in this site

EnablePersonalization Gets or sets a value indicating whether [enable personalization].

EnableVisitorTracking Gets or sets a value indicating whether /[enable visitor tracking].

EncryptedKey

EntityStringValue

ErrorPage Gets or sets the path to the error page.

ExternalUrl Gets or sets the external URL.

FavIconBinaryFile Gets or sets the favicon binary file.

FavIconBinaryFileId Gets or sets the favicon binary file identifier.

ForeignGuid

ForeignId

ForeignKey

GoogleAnalyticsCode Gets or sets the Google analytics code.

Guid

Id

IdKey

IndexStartingLocation Gets or sets the index starting location.

IsActive Gets or sets a value indicating whether this instance is active.

IsIndexEnabled Gets or sets a value indicating whether this instance is index enabled.

IsSystem Gets or sets a flag indicating if this Site was created by and is part of the Rock core system/framework. This property is required.

IsValid

Item

LatestVersionDateTime Gets or sets the latest version date time.

Layouts Gets or sets a collection of Layout entities that are a part of the Site.

LoginPage Gets or sets the login Page page for the site.

LoginPageId Gets or sets the Id of the Site's log in Page

LoginPageRoute Gets or sets the login PageRoute page route for this site. If this value is null, the LoginPage will be used

LoginPageRouteId Gets or sets the login page route unique identifier. If this has a value (and the PageRoute can be found) use this instead of the LoginPageId

MobilePage Gets or sets the mobile page.

MobilePageId Gets or sets the mobile page identifier.

ModifiedAuditValuesAlreadyUpdated

ModifiedByPersonAlias

ModifiedByPersonAliasId

ModifiedByPersonId

ModifiedByPersonName

ModifiedDateTime

Name Gets or sets the name of the Site. This property is required.

PageHeaderContent Gets or sets the content of the page header.

PageNotFoundPage Gets or sets the 404 Page page for the site.

PageNotFoundPageId Gets or sets the Id of the 404 Page

PageNotFoundPageRoute Gets or sets the 404 PageRoute page route for this site.

PageNotFoundPageRouteId Gets or sets the 404 page route unique identifier.

ParentAuthority

ParentAuthorityPre

RedirectTablets Gets or sets a value indicating whether [redirect tablets].

RegistrationPage Gets or sets the registration Page page for the site.

RegistrationPageId Gets or sets the Id of the Site's registration Page

RegistrationPageRoute Gets or sets the registration PageRoute page route for this site. If this value is null, the RegistrationPage will be used

RegistrationPageRouteId Gets or sets the registration page route unique identifier. If this has a value (and the PageRoute can be found) use this instead of the RegistrationPageId

RequiresEncryption Gets or sets a value indicating whether [requires encryption].

SiteAttributeValues Gets the entity attribute values. This should only be used inside LINQ statements when building a where clause for the query. This property should only be used inside LINQ statements for filtering or selecting values. Do not use it for accessing the attributes after the entity has been loaded.

SiteDomains Gets or sets the collection of SiteDomain entities that reference the Site.

SiteLogoBinaryFile Gets or sets the site logo binary file.

SiteLogoBinaryFileId Gets or sets the site logo binary file identifier.

SiteType

Gets or sets the type of the site. This is a hard coded list of values defined in the code as an enumeration.
Show Values

SupportedActions Provides a Dictionary`2 of actions that this model supports, and the description of each.

Theme Gets or sets the name of the Theme that is used on the Site.

ThumbnailBinaryFile Gets or sets the thumbnail binary file.

ThumbnailBinaryFileId Gets or sets the thumbnail binary file identifier.

ThumbnailFileUrl Gets the thumbnail file URL.

TypeId

TypeName

UrlEncodedKey

ValidationResults

AllowPerson(System.String action, Rock.Model.Person person, Rock.Data.RockContext rockContext) (inherited)
AllowSecurityRole(System.String action, Rock.Model.Group group, Rock.Data.RockContext rockContext) (inherited)
BulkIndexDocuments() - Bulks the index documents.
Clone() (inherited)
ContainsKey(System.Object key) (inherited) [Obsoleted in v13] Use ContainsKey(string) instead.
ContainsKey(System.String key) (inherited)
DeleteIndexedDocument(System.Int32 id)
DeleteIndexedDocuments() - Deletes the indexed documents.
Equals(System.Object obj) (inherited)
FromDictionary(System.Collections.Generic.Dictionary`2[System.String,System.Object] properties) (inherited)
GetAlternateEntityIds(Rock.Data.RockContext rockContext) (inherited) [Obsoleted in v13] Use GetAlternateEntityIdsByType instead.
GetAlternateEntityIdsByType(Rock.Data.RockContext rockContext) (inherited)
GetAttributeValue(System.String key) (inherited)
GetAttributeValue(System.Guid guid) (inherited)
GetAttributeValueAsType(System.String key) (inherited)
GetAttributeValues(System.String key) (inherited)
GetCacheObject() - Gets the cache object associated with this Entity
GetCreatedAuditHtml(System.String rootUrl) (inherited)
GetHashCode() (inherited)
GetIndexFilterConfig() - Gets the index filter values.
GetInheritedAttributes(Rock.Data.RockContext rockContext) (inherited)
GetModifiedAuditHtml(System.String rootUrl) (inherited)
GetType() (inherited)
GetValue(System.String key) (inherited)
IndexDocument(System.Int32 id)
IndexModelType() - Indexes the name of the model.
IsAllowedByDefault(System.String action) (inherited)
IsAuthorized(System.String action, Rock.Model.Person person) (inherited)
IsPrivate(System.String action, Rock.Model.Person person) (inherited)
LaunchWorkflow(System.Nullable`1[System.Guid] workflowTypeGuid, System.String workflowName, System.Collections.Generic.Dictionary`2[System.String,System.String] workflowAttributeValues) (inherited) [Obsoleted in v13] Use the override that does not provide the default values instead.
LaunchWorkflow(System.Nullable`1[System.Guid] workflowTypeGuid, System.String workflowName, System.Collections.Generic.Dictionary`2[System.String,System.String] workflowAttributeValues, System.Nullable`1[System.Int32] initiatorPersonAliasId) (inherited)
LaunchWorkflow(System.Nullable`1[System.Int32] workflowTypeId, System.String workflowName, System.Collections.Generic.Dictionary`2[System.String,System.String] workflowAttributeValues) (inherited) [Obsoleted in v13] Use the override that does not provide the default values instead.
LaunchWorkflow(System.Nullable`1[System.Int32] workflowTypeId, System.String workflowName, System.Collections.Generic.Dictionary`2[System.String,System.String] workflowAttributeValues, System.Nullable`1[System.Int32] initiatorPersonAliasId) (inherited)
MakePrivate(System.String action, Rock.Model.Person person, Rock.Data.RockContext rockContext) (inherited)
MakeUnPrivate(System.String action, Rock.Model.Person person, Rock.Data.RockContext rockContext) (inherited)
PostSaveChanges(Rock.Data.DbContext dbContext) (inherited)
PreSaveChanges(Rock.Data.DbContext dbContext, System.Data.Entity.EntityState state) (inherited)
PreSaveChanges(Rock.Data.DbContext dbContext, System.Data.Entity.Infrastructure.DbEntityEntry entry) (inherited)
PreSaveChanges(Rock.Data.DbContext dbContext, System.Data.Entity.Infrastructure.DbEntityEntry entry, System.Data.Entity.EntityState state) (inherited)
SetAttributeValue(System.String key, System.String value) (inherited)
SupportsIndexFieldFiltering() - Gets the index filter field.
ToDictionary() (inherited)
ToLiquid() (inherited)
ToString() - Returns a String containing the Name of the site that represents this instance.
UpdateCache(System.Data.Entity.EntityState entityState, Rock.Data.DbContext dbContext)

Model Map

Model Map

Check -in

CMS

Communication

Core

CRM

Engagement

Event

Finance

Group

LMS

Meta

Prayer

Reporting

Security

Web Farm

Workflow

Other

CMS Models

Key

Model Details

Site

Properties

Methods