Watch our RX24 Keynotes!

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

GroupType

Represents a type or category of Groups in Rock. A GroupType is also used to configure how Groups that belong to a GroupType will operate and how they will interact with other components of Rock.
Properties
AdditionalLavaFields
AdministratorTerm Gets or sets the administrator term for the group of this GroupType.
AllowAnyChildGroupType Gets or sets a value indicating if group type allows any child group type.
AllowedScheduleTypes Gets or sets the allowed schedule types. This is a hard coded list of values defined in the code as an enumeration.
Show Values
AllowGroupSync Gets or sets a flag indicating if groups of this type are allowed to be sync'ed.
AllowMultipleLocations Gets or sets a flag indicating if Groups of this type are allowed to have multiple locations.
AllowSpecificGroupMemberAttributes Gets or sets a flag indicating if specific groups are allowed to have their own member attributes.
AllowSpecificGroupMemberWorkflows Gets or sets a flag indicating if groups of this type should be allowed to have Group Member Workflows.
AlreadyEnrolledMatchingLogic

When AttendanceRule is set to then this specifies the group matching logic used.

simply that the person be a member of the group and no additional filtering is performed.

will additionally then filter out any non-preferred groups if the person is a member of any preferred groups.

This is a hard coded list of values defined in the code as an enumeration.
Show Values
AttendanceCountsAsWeekendService Gets or sets a value indicating whether [attendance counts as weekend service].
AttendancePrintTo Gets or sets the PrintTo indicating the type of location of where attendee labels for Groups of this GroupType should print. This is a hard coded list of values defined in the code as an enumeration.
Show Values
AttendanceReminderFollowupDays Gets or sets the attendance reminder followup days. This is a comma-delimited list of integer values. See AttendanceReminderFollowupDaysList
AttendanceReminderFollowupDaysList Gets or sets the attendance reminder followup days list. This is the logical representation of AttendanceReminderFollowupDays.
AttendanceReminderSendStartOffsetMinutes Gets or sets the attendance reminder send start offset minutes.
AttendanceReminderSystemCommunication Gets or sets the attendance reminder system communication.
AttendanceReminderSystemCommunicationId Gets or sets the attendance reminder system communication identifier.
AttendanceRule Gets or sets the AttendanceRule that indicates how attendance is managed a Group of this GroupType This is a hard coded list of values defined in the code as an enumeration.
Show Values
Attributes
AttributeValueDefaults
AttributeValues
AvailableKeys
ChildGroupTypes Gets or sets the collection of GroupTypes that inherit from this GroupType.
ContextKey
CreatedByPersonAlias
CreatedByPersonAliasId
CreatedByPersonId
CreatedByPersonName
CreatedDateTime
CustomSortValue
DefaultGroupRole Gets or sets the default GroupTypeRole for GroupMembers who belong to a Group of this GroupType.
DefaultGroupRoleId Gets or sets the Id of the GroupTypeRole that a GroupMember of a Group belonging to this GroupType is given by default.
Description Gets or sets the Description of the GroupType.
EnableGroupHistory Gets or sets a value indicating whether group history should be enabled for groups of this type
EnableGroupTag Gets or sets a value indicating whether group tag should be enabled for groups of this type
EnableInactiveReason Gets or sets a value indicating whether [enable inactive reason].
EnableLocationSchedules Gets or sets the enable location schedules.
EnableRSVP Indicates whether RSVP functionality should be enabled for this group.
EnableSpecificGroupRequirements Gets or sets a flag indicating if group requirements section is enabled for group of this type.
EncryptedKey
EntityStringValue
ForeignGuid
ForeignId
ForeignKey
GroupAttendanceRequiresLocation Gets or sets a value indicating whether [group attendance requires location].
GroupAttendanceRequiresSchedule Gets or sets a value indicating whether [group attendance requires schedule].
GroupCapacityRule Gets or sets the group capacity rule. This is a hard coded list of values defined in the code as an enumeration.
Show Values
GroupCount Gets a count of Groups that belong to this GroupType.
GroupMemberTerm Gets or sets the term that a GroupMember of a Group that belongs to this GroupType is called.
GroupMemberWorkflowTriggers Gets or sets the group member workflow triggers.
GroupQuery Gets a queryable collection of Groups that belong to this GroupType.
GroupRequirements Gets or sets the group requirements for groups of this Group Type (NOTE: Groups also can have additional GroupRequirements )
Groups Gets or sets a collection of the Groups that belong to this GroupType.
GroupScheduleExclusions Gets or sets the group schedule exclusions.
GroupsRequireCampus Gets or sets a value indicating whether [groups require campus].
GroupStatusDefinedType Gets or sets the DefinedType that Groups of this type will use for the Group.StatusValue
GroupStatusDefinedTypeId Gets or sets the DefinedType that Groups of this type will use for the Group.StatusValue
GroupTerm Gets or sets the term that a Group belonging to this GroupType is called.
GroupTypeColor The color used to visually distinguish groups on lists.
GroupTypePurposeValue Gets or sets the DefinedValue that represents the purpose of the GroupType.
GroupTypePurposeValueId Gets or sets Id of the DefinedValue that represents the purpose of the GroupType. These are found in the "Group Type Purpose" Defined Type.
Show Values
GroupViewLavaTemplate Gets or sets a lava template that can be used for generating view details for Group.
Guid
IconCssClass Gets or sets the icon CSS class name for a font vector based icon.
Id
IdKey
IgnorePersonInactivated Gets or sets a value indicating whether to ignore person inactivated. By default group members are inactivated in their group whenever the person is inactivated. If this value is set to true, members in groups of this type will not be marked inactive when the person is inactivated
InheritedGroupType Gets or sets the GroupType that this GroupType is inheriting settings and properties from. This is similar to a parent or a template GroupType.
InheritedGroupTypeId Gets or sets the Id of the GroupType to inherit settings and properties from. This is essentially copying the values, but they can be overridden.
IsCapacityRequired Gets or sets a value indicating whether this instance is capacity required.
IsConcurrentCheckInPrevented Gets or sets a value that groups in this area should not be available when a person already has a check-in for the same schedule.
IsIndexEnabled Gets or sets a value indicating whether this instance is index enabled.
IsPeerNetworkEnabled Gets or sets a value indicating whether the Group Type has Peer Network enabled.
IsSchedulingEnabled Gets or sets a value indicating whether scheduling is enabled for groups of this type
IsSystem Gets or sets a flag indicating if this GroupType is part of the Rock core system/framework. This property is required.
IsValid Gets a value indicating whether this instance is valid.
Item
LeaderToLeaderRelationshipMultiplier Gets or sets the leader to leader relationship multiplier.
LeaderToNonLeaderRelationshipMultiplier Gets or sets the leader to non leader relationship multiplier.
LocationSelectionMode Gets or sets selection mode that the Location Picker should use when adding locations to groups of this type This is a hard coded list of values defined in the code as an enumeration.
Show Values
LocationTypes Gets or sets a collection of the GroupTypeLocationTypes that are associated with this GroupType.
ModifiedAuditValuesAlreadyUpdated
ModifiedByPersonAlias
ModifiedByPersonAliasId
ModifiedByPersonId
ModifiedByPersonName
ModifiedDateTime
Name Gets or sets the Name of the GroupType. This property is required.
NonLeaderToLeaderRelationshipMultiplier Gets or sets the non leader to leader relationship multiplier.
NonLeaderToNonLeaderRelationshipMultiplier Gets or sets the non leader to non leader relationship multiplier.
Order Gets or sets the order for this GroupType. This is used for display and priority purposes, the lower the number the higher the priority, or the higher the GroupType is displayed. This property is required.
ParentAuthority
ParentAuthorityPre
ParentGroupTypes Gets or sets a collection containing the GroupTypes that this GroupType inherits from.
RelationshipGrowthEnabled Gets or sets a value indicating whether relationship growth is enabled.
RelationshipStrength Gets or sets the relationship strength.
RequiresInactiveReason Gets or sets a value indicating whether [requires inactive reason].
RequiresReasonIfDeclineSchedule Gets or sets a value indicating whether a person must specify a reason when declining/cancelling.
Roles Gets or sets a collection containing the GroupRoles that this GroupType utilizes.
RSVPReminderOffsetDays Gets or sets the number of days prior to the RSVP date that a reminder should be sent.
RSVPReminderSystemCommunicationId Gets or sets the system communication to use for sending an RSVP reminder.
ScheduleCancellationWorkflowType Gets or sets the WorkflowType to execute when a person indicates they won't be able to attend at their scheduled time
ScheduleCancellationWorkflowTypeId Gets or sets the WorkflowType to execute when a person indicates they won't be able to attend at their scheduled time
ScheduleConfirmationEmailOffsetDays Gets or sets the number of days prior to the schedule to send a confirmation email.
ScheduleConfirmationLogic Gets or sets the schedule confirmation logic. This is a hard coded list of values defined in the code as an enumeration.
Show Values
ScheduleConfirmationSystemCommunication Gets or sets the system communication to use when a person is scheduled or when the schedule has been updated
ScheduleConfirmationSystemCommunicationId Gets or sets the system communication to use when a person is scheduled or when the schedule has been updated.
ScheduleConfirmationSystemEmail [Obsoleted in v10] Use ScheduleConfirmationSystemCommunication instead. Gets or sets the system email to use when a person is scheduled or when the schedule has been updated
ScheduleConfirmationSystemEmailId [Obsoleted in v10] Use ScheduleConfirmationSystemCommunicationId instead. Gets or sets the system email to use when a person is scheduled or when the schedule has been updated
ScheduleCoordinatorNotificationTypes Gets or sets the types of notifications the coordinator receives about scheduled individuals.
ScheduleReminderEmailOffsetDays Gets or sets the number of days prior to the schedule to send a reminder email. See also GroupMember.ScheduleReminderEmailOffsetDays.
ScheduleReminderSystemCommunication Gets or sets the system communication to use when sending a Schedule Reminder
ScheduleReminderSystemCommunicationId Gets or sets the system communication to use when sending a schedule reminder.
ScheduleReminderSystemEmail [Obsoleted in v10] Use ScheduleReminderSystemCommunication instead. Gets or sets the system email to use when sending a Schedule Reminder
ScheduleReminderSystemEmailId [Obsoleted in v10] Use ScheduleReminderSystemCommunicationId instead. Gets or sets the system email to use when sending a schedule reminder
SendAttendanceReminder Gets or sets a value indicating if an attendance reminder should be sent to group leaders.
ShowAdministrator Gets or sets a value indicating whether administrator for the group of this GroupType will be shown.
ShowConnectionStatus Gets or sets a value indicating whether to show the Person's connection status as a column in the Group Member Grid
ShowInGroupList Gets or sets a flag indicating if a Group of this GroupType will be shown in the group list.
ShowInNavigation Gets or sets a flag indicating if this GroupType and its Groups are shown in Navigation. If false, this GroupType will be hidden navigation controls, such as TreeViews and Menus
ShowMaritalStatus Gets or sets a value indicating whether to show the Person's marital status as a column in the Group Member Grid
SupportedActions Provides a Dictionary`2 of actions that this model supports, and the description of each.
TakesAttendance Gets or sets a flag indicating if a Group of this GroupType supports taking attendance.
TypeId
TypeName
UrlEncodedKey
ValidationResults