Watch our RX24 Keynotes!

Model Map

Model Details

Show: Methods

PageRoute

Represents a PageRoute object in Rock. All pages in Rock are accessed via a PageRoute. The default route that is used in Rock is /page/{pageId} (for example /page/113 tells Rock to load the Page associated with PageId 113). This model allows for custom page routes to be created, which in turn allows us to use Friendlier Urls (for example the default New Account page can be accessed by /NewAccount as well as /page/4).
Properties
AdditionalLavaFields
Attributes
AttributeValueDefaults
AttributeValues
AvailableKeys
ContextKey
CreatedByPersonAlias
CreatedByPersonAliasId
CreatedByPersonId
CreatedByPersonName
CreatedDateTime
CustomSortValue
EncryptedKey
EntityStringValue
ForeignGuid
ForeignId
ForeignKey
Guid
Id
IdKey
IsGlobal If true then the route will be accessible from all sites regardless if EnableExclusiveRoutes is set on the site
IsSystem Gets or sets a flag indicating if the PageRoute is part of the Rock core system/framework. This property is required.
IsValid
Item
ModifiedAuditValuesAlreadyUpdated
ModifiedByPersonAlias
ModifiedByPersonAliasId
ModifiedByPersonId
ModifiedByPersonName
ModifiedDateTime
Page Gets or sets the Page associated with the RoutePath.
PageId Gets or sets the Id of the Page that the PageRoute is linked to. This property is required.
ParentAuthority
ParentAuthorityPre
Route Gets or sets the format of the route path. Route examples include: Page

NewAccount

or

Checkin/Welcome

. A specific group

Group/{GroupId} (i.e. Group/16)

. A person's history

Person/{PersonId}/History (i.e. Person/12/History)

. This property is required.
SupportedActions
TypeId
TypeName
UrlEncodedKey
ValidationResults