Group
Represents A collection of
Person entities. This can be a family, small group, Bible study, security group, etc. Groups can be hierarchical.
| AdditionalLavaFields | |
| AllowGuests | Gets or sets whether group allows members to specify additional "guests" that will be part of the group (i.e. attend event) |
| AllowsInteractiveBulkIndexing | Gets a value indicating whether [allows interactive bulk indexing]. |
| ArchivedByPersonAlias | Gets or sets the PersonAlias that archived (soft deleted) this group |
| ArchivedByPersonAliasId | Gets or sets the PersonAliasId that archived (soft deleted) this group |
| ArchivedDateTime | Gets or sets the date time that this group was archived (soft deleted) |
| AreAnyRelationshipMultipliersCustomized | Gets whether any relationship multipliers have been customized for this group or its parent group type. |
| AttendanceRecordRequiredForCheckIn | Gets or sets the attendance record required for check in. This is a hard coded list of values defined in the code as an enumeration.
Show Values | 0 | ScheduleNotRequired | | 1 | PreSelect | | 2 | ScheduleRequired |
|
| Attributes | |
| AttributeValueDefaults | |
| AttributeValues | |
| AvailableKeys | |
| Campus | Gets or sets the Campus that this Group is associated with. |
| CampusId | Gets or sets the Id of the Campus that this Group is associated with. |
| ChatChannelKey | Gets or sets the identifier of the chat channel in the external chat service. No assumptions should be made that if this value is set the channel still exists in the external chat service. |
| ConfirmationAdditionalDetails | Gets or sets the confirmation additional details. |
| ContextKey | |
| CreatedByPersonAlias | |
| CreatedByPersonAliasId | |
| CreatedByPersonId | |
| CreatedByPersonName | |
| CreatedDateTime | |
| CustomSortValue | |
| Description | Gets or sets the optional description of the group. |
| DisableScheduleToolboxAccess | Gets or sets a flag indicating if the schedule toolbox access is disabled. |
| DisableScheduling | Gets or sets a flag indicating if scheduling is disabled. |
| ElevatedSecurityLevel | Gets or sets the elevated security level. This setting is used to determine the group member's Account Protection Profile. This is a hard coded list of values defined in the code as an enumeration.
Show Values |
| EncryptedKey | |
| EntityStringValue | |
| ForeignGuid | |
| ForeignId | |
| ForeignKey | |
| GroupAdministratorPersonAlias | Gets or sets the group administrator PersonAlias. |
| GroupAdministratorPersonAliasId | Gets or sets the group administrator PersonAlias identifier. |
| GroupAttributeValues | 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. |
| GroupCapacity | Gets or sets the group capacity. |
| GroupLocations | Gets or Sets the GroupLocations that are associated with the Group. |
| GroupMemberWorkflowTriggers | Gets or sets the Group Member Workflow Triggers. |
| GroupRequirements | Gets or sets the group requirements (not including GroupRequirements from the GroupType) |
| Groups | Gets or sets a collection the Groups that are children of this group. |
| GroupSalutation | List leaders names, in order by males → females. Examples: Ted & Cindy Decker -or- Ted Decker & Cindy Wright. |
| GroupSalutationFull | List all active group members, or order by leaders males → females - non leaders by age. Examples: Ted, Cindy, Noah and Alex Decker. |
| GroupSyncs | Gets or sets the group syncs. |
| GroupType | Gets or sets the GroupType that this Group is a member of. |
| GroupTypeId | Gets or sets the Id of the GroupType that this Group is a member belongs to. This property is required. |
| Guid | |
| HistoryChangeList | [Obsoleted in v14] Does nothing. No longer needed. We replaced this with a private property under the SaveHook class for this entity. Gets or sets the history change list. |
| Id | |
| IdKey | |
| InactiveDateTime | Gets or sets the date that this group became inactive |
| InactiveReasonNote | Gets or sets the inactive reason note. |
| InactiveReasonValue | Gets or sets the inactive group reason. |
| InactiveReasonValueId | Gets or sets the inactive reason value identifier. These are found in the "Inactive Group Reasons" Defined Type.
Show Values |
| IsActive | Gets or sets a flag indicating if this is an active group. This value is required. |
| IsArchived | Gets or sets a value indicating whether this group is archived (soft deleted) |
| IsChatChannelAlwaysShownOverride | Gets or sets whether this chat channel is always shown in the channel list even if the person has not joined the channel. This also implies that the channel may be joined by any person via the chat application. If set to , then the value of GroupType.IsChatChannelAlwaysShown will be used. This should only be used when editing the group. Call the method instead to determine if the chat channel is always shown, as that method will also check the GroupType.IsChatChannelAlwaysShown property. |
| IsChatChannelPublicOverride | Gets or sets whether this chat channel is public. A public channel is visible to everyone when performing a search. This also implies that the channel may be joined by any person via the chat application. If set to , then the value of GroupType.IsChatChannelPublic will be used. This should only be used when editing the group. Call the method instead to determine if the chat channel is public, as that method will also check the GroupType.IsChatChannelPublic property. |
| IsChatEnabledOverride | Gets or sets whether chat is enabled for this group. If set to (or if the parent GroupType.IsChatAllowed is set to ), then the group will not have chat enabled. If set to , then it will have chat enabled. If set to , then the value from GroupType.IsChatEnabledForAllGroups will be used. This should only be used when editing the group. Call the method instead to determine if the group is being used for chat, as that method will also check the GroupType.IsChatAllowed and GroupType.IsChatEnabledForAllGroups properties. |
| IsLeavingChatChannelAllowedOverride | Gets or sets whether individuals are allowed to leave this chat channel. If set to , then they will only be allowed to mute the channel. If set to , then they will be allowed to both leave and mute the channel. If set to , then the value of GroupType.IsLeavingChatChannelAllowed will be used. This should only be used when editing the group. Call the method instead to determine if leaving is allowed, as that method will also check the GroupType.IsLeavingChatChannelAllowed property. |
| IsOverridingGroupTypePeerNetworkConfiguration | Gets whether this group is overriding its parent group type's peer network configuration in any way. |
| IsPublic | Gets or sets a value indicating whether the group should be shown in group finders |
| IsSecurityRole | Indicates this Group is a Security Role even though it isn't a SecurityRole Group Type. Note: Don't use this alone to determine if a Group is a security role group. Use to see if a Group is for a Security Role. |
| IsSpecialNeeds | Gets or sets a value that indicates if this group is a special needs group. For a check-in group, this indicates that the group is intended for people with special needs. It can be used in other contexts to have different meaning for "special needs". |
| IsSystem | Gets or sets a flag indicating if this Group is a part of the Rock core system/framework. This property is required. |
| IsValid | Gets a value indicating whether this instance is valid. |
| Item | |
| LeaderToLeaderRelationshipMultiplierOverride | Gets or sets the leader to leader relationship multiplier. |
| LeaderToNonLeaderRelationshipMultiplierOverride | Gets or sets the leader to non leader relationship multiplier. |
| Linkages | Gets or sets the linkages. |
| Members | Gets or sets a collection containing the GroupMembers who are associated with the Group. Note that this does not include Archived GroupMembers |
| ModifiedAuditValuesAlreadyUpdated | |
| ModifiedByPersonAlias | |
| ModifiedByPersonAliasId | |
| ModifiedByPersonId | |
| ModifiedByPersonName | |
| ModifiedDateTime | |
| Name | Gets or sets the Name of the Group. This property is required. |
| NonLeaderToLeaderRelationshipMultiplierOverride | Gets or sets the non leader to leader relationship multiplier. |
| NonLeaderToNonLeaderRelationshipMultiplierOverride | Gets or sets the non leader to non leader relationship multiplier. |
| Order | Gets or sets the display order of the group in the group list and group hierarchy. The lower the number the higher the display priority this group has. This property is required. |
| ParentAuthority | Gets the securable object that security permissions should be inherited from. If block is located on a page security will be inherited from the page, otherwise it will be inherited from the site. |
| ParentAuthorityPre | An optional additional parent authority. (i.e for Groups, the GroupType is main parent authority, but parent group is an additional parent authority ) |
| ParentGroup | Gets or sets this parent Group of this Group. |
| ParentGroupId | Gets or sets the Id of the Group's Parent Group. |
| RelationshipGrowthEnabledOverride | Gets or sets a value indicating whether relationship growth is enabled. |
| RelationshipStrengthOverride | Gets or sets the relationship strength. |
| ReminderAdditionalDetails | Gets or sets the reminder additional details. |
| ReminderOffsetDays | Gets or sets the number of days prior to an event date that a reminder should be sent. |
| ReminderSystemCommunicationId | Gets or sets the system communication to use for sending a reminder. |
| RequiredSignatureDocumentTemplate | Gets or sets the type of the required signature document. |
| RequiredSignatureDocumentTemplateId | Gets or sets the required signature document type identifier. |
| RSVPReminderOffsetDays | Gets or sets the number of days prior to the RSVP date that a reminder should be sent. |
| RSVPReminderSystemCommunication | Gets or sets the system communication to use for sending an RSVP reminder. |
| RSVPReminderSystemCommunicationId | Gets or sets the system communication to use for sending an RSVP reminder. |
| Schedule | Gets or sets the Schedule. |
| ScheduleCancellationPersonAlias | [Obsoleted in v16] Use ScheduleCoordinatorPersonAlias instead. Gets or sets the PersonAlias of the person to notify when a person cancels |
| ScheduleCancellationPersonAliasId | [Obsoleted in v16] Use ScheduleCoordinatorPersonAliasId instead. Gets or sets the PersonAliasId of the person to notify when a person cancels |
| ScheduleConfirmationLogic | Gets or sets the schedule confirmation logic. |
| ScheduleCoordinatorNotificationTypes | Gets or sets the types of notifications the coordinator receives about scheduled individuals. |
| ScheduleCoordinatorPersonAlias | Gets or sets the PersonAlias of the person who receives notifications about changes to scheduled individuals. |
| ScheduleCoordinatorPersonAliasId | Gets or sets the PersonAliasId of the person who receives notifications about changes to scheduled individuals. |
| ScheduleId | Gets or sets the Schedule identifier. |
| SchedulingMustMeetRequirements | Gets or sets a value indicating whether GroupMembers must meet GroupMemberRequirements before they can be scheduled. |
| StatusValue | Gets or sets the DefinedValue representing the Group's status. DefinedType depends on this group's GroupType.GroupTypePurposeValue |
| StatusValueId | Gets or sets the Group Status Id. DefinedType depends on this group's GroupType.GroupStatusDefinedType |
| SupportedActions | Provides a Dictionary`2 of actions that this model supports, and the description of each. |
| TypeId | |
| TypeName | |
| UrlEncodedKey | |
| ValidationResults | |