Watch our RX24 Keynotes!

Model Map

Model Map

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 methods or fields are obsolete and should not be used.

Model Details

Show: Methods

Schedule

Represents a Scheduled event in Rock. Several places where this has been used includes Check-in scheduling and Kiosk scheduling.
Properties
AbbreviatedName Gets or sets the shortened name of the attribute. If null or whitespace then the full name is returned.
AdditionalLavaFields
Attributes
AttributeValueDefaults
AttributeValues
AutoInactivateWhenComplete Gets or sets a value indicating whether [auto inactivate when complete].
AvailableKeys
Category Gets or sets the Category that this Schedule belongs to.
CategoryId Gets or sets the CategoryId of the Category that this Schedule belongs to.
CheckInEndOffsetMinutes Gets or sets the number of minutes following schedule start that Check-in should be active. 0 represents that Check-in will only be available until the Schedule's start time.
CheckInStartOffsetMinutes Gets or sets the number of minutes prior to the Schedule's start time that Check-in should be active. 0 represents that Check-in will not be available to the beginning of the event.
ContextKey
CreatedByPersonAlias
CreatedByPersonAliasId
CreatedByPersonId
CreatedByPersonName
CreatedDateTime
CustomSortValue
Description Gets or sets a user defined Description of the Schedule.
DurationInMinutes Gets the duration in minutes.
EffectiveEndDate Gets or sets that date that this Schedule expires and becomes inactive. This value is inclusive and the schedule will be inactive after this date.
EffectiveStartDate Gets or sets the Date that the Schedule becomes effective/active. This property is inclusive, and the schedule will be inactive before this date.
EncryptedKey
EntityStringValue
FirstStartDateTime Gets the first start date time.
FirstStartDateTimeThisWeek Gets the first start date time this week.
ForeignGuid
ForeignId
ForeignKey
FriendlyScheduleText Gets the friendly schedule text.
Guid
iCalendarContent Gets or sets the content lines of the iCalendar
Id
IdKey
IsActive Gets or sets a flag indicating if this is an active schedule. This value is required.
IsCheckInActive Gets a value indicating whether check-in is currently active for this schedule. This is based on Rock.RockDateTime.Now. Use Campus.CurrentDateTime and to get this based on the Campus's current datetime.
IsCheckInEnabled Gets a value indicating whether Check-in is enabled for this Schedule.
IsPublic Gets or sets a value indicating if this Schedule is public.
IsScheduleActive Gets a value indicating whether this schedule is currently active. This is based on Rock.RockDateTime.Now. Use Campus.CurrentDateTime and to get this based on the Campus's current datetime.
IsValid
Item
ModifiedAuditValuesAlreadyUpdated
ModifiedByPersonAlias
ModifiedByPersonAliasId
ModifiedByPersonId
ModifiedByPersonName
ModifiedDateTime
Name Gets or sets the Name of the Schedule. This property is required.
NextStartDateTime Gets the next start time based on Rock.RockDateTime.Now. Use Campus.CurrentDateTime and to get this based on the Campus's current datetime.
Order Gets or sets the order. Use to get the schedules in the desired order.
ParentAuthority
ParentAuthorityPre
ScheduleType Gets the type of the schedule. This is a hard coded list of values defined in the code as an enumeration.
Show Values
StartTimeOfDay Gets the start time of day.
SupportedActions
TypeId
TypeName
UrlEncodedKey
ValidationResults
WeeklyDayOfWeek Gets or sets the weekly day of week.
WeeklyTimeOfDay Gets or sets the weekly time of day.
WeeklyTimeOfDayText Gets the weekly time of day in friendly text, such as "7:00 PM".