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

Person

Represents a person or a business in Rock.
Properties
AccountProtectionProfile Gets or sets the person's account protection profile, which is used by the duplication detection and merge processes. This is a hard coded list of values defined in the code as an enumeration.
Show Values
AdditionalLavaFields
Age Gets the Person's age.
AgeBracket Gets or sets the age bracket. This is a hard coded list of values defined in the code as an enumeration.
Show Values
AgeClassification Gets or sets the age classification of the Person. Note: This is computed on save, so any manual changes to this will be ignored. This is a hard coded list of values defined in the code as an enumeration.
Show Values
AgePrecise Gets the Person's precise age (includes the fraction of the year).
Aliases Gets or sets the aliases for this person.
AllowsInteractiveBulkIndexing Gets a value indicating whether [allows interactive bulk indexing].
AnniversaryDate Gets or sets the date of the Person's wedding anniversary. This property is nullable if the Person is not married or their anniversary date is not known.
Attributes
AttributeValueDefaults
AttributeValues
AvailableKeys
BirthDate Gets the Person's birth date. Note: Use set the Birthdate
BirthDateKey Gets or sets the birth date key.
BirthDay Gets or sets the day of the month portion of the Person's birth date.
BirthdayDayOfWeek Gets the day of the week the person's birthday falls on for the current year.
BirthdayDayOfWeekShort Gets the day of the week the person's birthday falls on for the current year as a shortened string (e.g. Wed.)
BirthMonth Gets or sets the month portion of the Person's birth date.
BirthYear Gets or sets the year portion of the Person's birth date.
CommunicationPreference Gets or sets the communication preference. This is a hard coded list of values defined in the code as an enumeration.
Show Values
ConnectionStatusValue Gets or sets the DefinedValue representing the Person's connection status
ConnectionStatusValueId Gets or sets the Id of the Defined Value DefinedValue representing the connection status of the Person. These are found in the "Connection Status" Defined Type.
Show Values
ContextKey
ContributionFinancialAccount Gets or sets the person's default FinancialAccount gift designation.
ContributionFinancialAccountId Gets or sets the person's default financial account gift designation.
CreatedByPersonAlias
CreatedByPersonAliasId
CreatedByPersonId
CreatedByPersonName
CreatedDateTime
CustomSortValue
DaysToAnniversary [Obsoleted in v17] Use the DaysToAnniversaryOrNull property instead. Gets the number of days until the Person's anniversary. This is an in-memory calculation. If needed in a LinqToSql query use DaysUntilAnniversary property instead
DaysToAnniversaryOrNull Gets the number of days until the Person's next anniversary. This is an in-memory calculation. If needed in a LinqToSql query, use the DaysUntilAnniversary property instead.
DaysToBirthday [Obsoleted in v17] Use the DaysToBirthdayOrNull property instead. Gets the number of days until the Person's birthday. This is an in-memory calculation. If needed in a LinqToSql query use DaysUntilBirthday property instead
DaysToBirthdayOrNull Gets the number of days until the Person's next birthday. This is an in-memory calculation. If needed in a LinqToSql query, use the DaysUntilBirthday property instead.
DaysUntilAnniversary Gets or sets the number of days until their next anniversary. This is a computed column and can be used in LinqToSql queries, but there is no in-memory calculation. Avoid using property outside of a linq query. Use DaysToAnniversary instead. NOTE: If their anniversary is Feb 29, and this isn't a leap year, it'll treat Feb 28th as their anniversary when doing this calculation
DaysUntilBirthday Gets or sets the number of days until their next birthday. This is a computed column and can be used in LinqToSql queries, but there is no in-memory calculation. Avoid using this property outside of a linq query. Use DaysToBirthday property instead NOTE: If their birthday is Feb 29, and this isn't a leap year, it'll treat Feb 28th as their birthday when doing this calculation
DeceasedDate Gets or sets the deceased date.
Email Gets or sets the Person's email address.
EmailNote Gets or sets a note about the Person's email address.
EmailPreference Gets or sets the email preference. This is a hard coded list of values defined in the code as an enumeration.
Show Values
EncryptedKey Creates and stores a new PersonToken for a person using the default ExpireDateTime and UsageLimit. Returns the encrypted URLEncoded Token which can be used as a rckipid. NOTE: Use the GetImpersonationParameter(...) methods to specify an expiration date, usage limit or pageid
EntityStringValue
EthnicityValue Gets or sets the DefinedValue representing the Person's Ethnicity
EthnicityValueId Gets or sets the Id of the Ethnicity DefinedValue representing the ethnicity of this person These are found in the "Person Ethnicity" Defined Type.
Show Values
FirstName Gets or sets the first name of the Person.
FirstNamePronunciationOverride Gets or sets the First Name pronunciation override.
ForeignGuid
ForeignId
ForeignKey
FullName Gets the Full Name of the Person using the NickName LastName Suffix format.
FullNameFormal Gets the Full Name of the Person using the Title FirstName LastName Suffix format.
FullNameFormalReversed Gets the full name of the Person using the LastName, FirstName format.
FullNameReversed Gets the full name of the Person using the LastName, FirstName format.
Gender Gets or sets the gender of the Person. This property is required. This is a hard coded list of values defined in the code as an enumeration.
Show Values
GivingGroup Gets or sets the giving group.
GivingGroupId Gets or sets the giving group id. If an individual would like their giving to be grouped with the rest of their family, this will be the id of their family group. If they elect to contribute on their own, this value will be null.
GivingId Gets the computed giver identifier in the format G{GivingGroupId} if they are part of a GivingGroup, or P{Personid} if they give individually
GivingLeaderId Gets or sets the giving leader's Person Id. Note: This is computed on save, so any manual changes to this will be ignored.
GradeFormatted Gets the grade string.
GradeOffset Gets or sets the grade offset, which is the number of years until their graduation date. This is used to determine which Grade (Defined Value) they are in
GraduationYear Gets or sets the date of the Person's projected or actual high school graduation year. This value is used to determine what grade a student is in.
Guid
HasGraduated Gets the has graduated.
Id
IdKey
ImpersonationParameter Creates and stores a new PersonToken for a person using the default ExpireDateTime and UsageLimit. Returns the encrypted URLEncoded Token along with the ImpersonationParameter key in the form of "rckipid={ImpersonationParameter}"
InactiveReasonNote Gets or sets the Inactive Reason Note
Initials Gets the initials for the person based on the nick name and last name.
IsDeceased Gets or sets a flag indicating if the Person is deceased.
IsEmailActive Gets or sets a flag indicating if the Person's email address is active.
IsLockedAsChild Gets or sets a flag indicating if the Person is locked as child.
IsSystem Gets or sets a flag indicating if this Person is part of the Rock core system/framework. This property is required.
IsValid
Item
LastName Gets or sets the last name (Sir Name) of the Person.
LastNamePronunciationOverride Gets or sets the last Name pronunciation override.
MaritalStatusValue Gets or sets the DefinedValue representing the Person's marital status.
MaritalStatusValueId Gets or sets Id of the Marital Status DefinedValue representing the Person's marital status. These are found in the "Marital Status" Defined Type.
Show Values
Members Gets or sets a collection of GroupMember entities representing the group memberships that are associated with this Person.
MiddleName Gets or sets the middle name of the Person.
ModifiedAuditValuesAlreadyUpdated
ModifiedByPersonAlias
ModifiedByPersonAliasId
ModifiedByPersonId
ModifiedByPersonName
ModifiedDateTime
NextAnniversary Gets the next anniversary.
NextBirthDay Gets the next birth day.
NickName Gets or sets the nick name of the Person. If a nickname was not entered, the first name is used.
NickNamePronunciationOverride Gets or sets the nick Name pronunciation override.
ParentAuthority
ParentAuthorityPre
PhoneNumbers Gets or sets a collection of PhoneNumbers
Photo Gets or sets the BinaryFile that contains the Person's photo.
PhotoId Gets or sets the Id of the BinaryFile that contains the photo of the Person.
PhotoUrl Gets the URL of the person's photo.
PreferredLanguageValue Gets or sets the DefinedValue representing the Person's preferred language.
PreferredLanguageValueId Gets or sets the DefinedValueId of the DefinedValue that represents the Preferred Language for this person.
PrimaryAlias Gets the primary alias.
PrimaryAliasId Gets the primary alias identifier.
PrimaryCampus Gets or sets the person's primary campus.
PrimaryCampusId Gets or sets the campus id for the primary family. Note: This is computed on save, so any manual changes to this will be ignored.
PrimaryFamily Gets or sets the primary family.
PrimaryFamilyId Gets or sets the group id for the PrimaryFamily. Note: This is computed on save, so any manual changes to this will be ignored.
PronunciationNote Gets or sets the notes for the pronunciation.
RaceValue Gets or sets the DefinedValue representing the Person's Race
RaceValueId Gets or sets the Id of the Race DefinedValue representing the race of this person These are found in the "Person Race" Defined Type.
Show Values
RecordStatusLastModifiedDateTime Gets or sets the record status last modified date time.
RecordStatusReasonValue Gets or sets the DefinedValue representing the Record Status Reason.
RecordStatusReasonValueId Gets or sets the Id of the Record Status Reason DefinedValue representing the reason why a person record status would have a set status. These are found in the "Inactive Record Reason" Defined Type.
Show Values
RecordStatusValue Gets or sets the DefinedValue representing the record status.
RecordStatusValueId Gets or sets the Id of the Record Status DefinedValue representing the status of this entity These are found in the "Record Status" Defined Type.
Show Values
RecordTypeValue Gets or sets the DefinedValue representing the RecordType.
RecordTypeValueId Gets or sets the Id of the Person Record Type DefinedValue representing what type of Person Record this is. These are found in the "Record Type" Defined Type.
Show Values
ReminderCount Gets or sets the reminder count associated with the Person.
ReviewReasonNote Gets or sets notes about why a person profile needs to be reviewed
ReviewReasonValue Gets or sets the review reason value.
ReviewReasonValueId Gets or sets the Id of the Defined Value DefinedValue representing the reason a record needs to be reviewed. These are found in the "Review Reason" Defined Type.
Show Values
Signals Gets or sets the signals applied to this person.
SuffixValue Gets or sets the DefinedValue representing the Person's name suffix.
SuffixValueId Gets or sets the Id of the Person's name Suffix DefinedValue. These are found in the "Suffix" Defined Type.
Show Values
SupportedActions
SystemNote Gets or sets the System Note
TitleValue Gets or sets the DefinedValue representing the Person's salutation title.
TitleValueId Gets or sets Id of the (Salutation) Tile DefinedValue that is associated with the Person These are found in the "Title" Defined Type.
Show Values
TopSignalColor Gets or sets the name of the top signal color. This property is used to indicate the icon color on a person if they have a related signal.
TopSignalIconCssClass Gets or sets the name of the top signal CSS class. This property is used to indicate which icon to display on a person if they have a related signal.
TopSignalId Gets or sets the highest priority PersonSignal associated with this person.
TypeId
TypeName
UrlEncodedKey Creates and stores a new PersonToken for a person using the default ExpireDateTime and UsageLimit. Returns the encrypted URLEncoded Token which can be used as a rckipid. NOTE: Use the GetImpersonationParameter(...) methods to specify an expiration date, usage limit or pageid
Users Gets or sets a collection containing the Person's UserLogins.
ValidationResults
ViewedCount Gets or sets the count of the number of times that the Person has been viewed.