GroupMember
Represents a member of a group in Rock. A group member is a
Person who has a relationship with a
Group.
| AdditionalLavaFields | |
| ArchivedByPersonAlias | Gets or sets the PersonAlias that archived (soft deleted) this group member |
| ArchivedByPersonAliasId | Gets or sets the PersonAliasId that archived (soft deleted) this group member |
| ArchivedDateTime | Gets or sets the date time that this group member was archived (soft deleted) |
| Attributes | |
| AttributeValueDefaults | |
| AttributeValues | |
| AvailableKeys | |
| CommunicationPreference | Gets or sets the communication preference. This is a hard coded list of values defined in the code as an enumeration.
Show Values | 0 | RecipientPreference | | 1 | Email | | 2 | SMS | | 3 | PushNotification |
|
| ContextKey | |
| CreatedByPersonAlias | |
| CreatedByPersonAliasId | |
| CreatedByPersonId | |
| CreatedByPersonName | |
| CreatedDateTime | |
| CustomSortValue | |
| DateTimeAdded | Gets or sets the date/time that the person was added to the group. Rock will automatically set this value when a group member is added if it isn't set manually |
| EncryptedKey | |
| EntityStringValue | |
| ForeignGuid | |
| ForeignId | |
| ForeignKey | |
| Group | Gets or sets the Group that the GroupMember belongs to. |
| GroupId | Gets or sets the Id of the Group that this GroupMember is associated with. This property is required. |
| GroupMemberAssignments | Gets or sets the group member assignments. |
| GroupMemberRequirements | Gets or sets the group member requirements. |
| GroupMemberStatus | Gets or sets the GroupMember's status (GroupMemberStatus) in the Group. This value is required. This is a hard coded list of values defined in the code as an enumeration.
Show Values |
| GroupOrder | Gets or sets the order of Groups of the Group's GroupType for the Person. For example, if this is a FamilyGroupType, GroupOrder can be used to specify which family should be listed as 1st (primary), 2nd, 3rd, etc for the Person. If GroupOrder is null, the group will be listed in no particular order after the ones that do have a GroupOrder. NOTE: Use int.MaxValue in OrderBy statements for null GroupOrder values |
| GroupRole | Gets or sets the GroupMember's role (GroupTypeRole) in the Group. |
| GroupRoleId | Gets or sets the Id of the GroupMember's GroupRole in the Group. This property is required. |
| GroupTypeId | Gets or sets the Id of the GroupType that this Group member belongs to. This property is required. |
| GuestCount | Gets or sets the number of additional guests that member will be bring to group. Only applies when group has the 'AllowGuests' flag set to true. |
| Guid | |
| Id | |
| IdKey | |
| InactiveDateTime | Gets or sets the date that this group member became inactive |
| IsArchived | Gets or sets a value indicating whether this group member is archived (soft deleted) |
| IsNotified | Gets or sets a value indicating whether this instance is notified. |
| IsSystem | Gets or sets a flag indicating if this GroupMember is part of the Rock core system/framework. This property is required. |
| IsValid | Gets a value indicating whether this instance is valid. NOTE: Try using IsValidGroupMember instead |
| Item | |
| ModifiedAuditValuesAlreadyUpdated | |
| ModifiedByPersonAlias | |
| ModifiedByPersonAliasId | |
| ModifiedByPersonId | |
| ModifiedByPersonName | |
| ModifiedDateTime | |
| Note | Gets or sets the note. |
| ParentAuthority | A parent authority. If a user is not specifically allowed or denied access to this object, Rock will check the default authorization on the current type, and then the authorization on the Rock.Security.GlobalDefault entity |
| ParentAuthorityPre | An optional additional parent authority. (i.e for Groups, the GroupType is main parent authority, but parent group is an additional parent authority ) |
| Person | Gets or sets the Person representing the GroupMember. |
| PersonId | Gets or sets the Id of the Person that is represented by the GroupMember. This property is required. |
| ScheduleReminderEmailOffsetDays | Gets or sets the number of days prior to the schedule to send a reminder email. See also GroupType.ScheduleReminderEmailOffsetDays. |
| ScheduleStartDate | Gets or sets the schedule start date to base the schedule off of. See GroupMemberScheduleTemplate. |
| ScheduleTemplate | Gets or sets the GroupMemberScheduleTemplate. |
| ScheduleTemplateId | Gets or sets the Id of the GroupMemberScheduleTemplate |
| SupportedActions | |
| TypeId | |
| TypeName | |
| UrlEncodedKey | |
| ValidationResults | |