Interface LineupParticipantPersonRegistered

Represents a participant who is registered in the system.

interface LineupParticipantPersonRegistered {
    age: null | number;
    arbitrary: undefined;
    firstName: string;
    fullName: string;
    gender: Gender;
    id: number;
    label: string;
    lastName: string;
    type: "Person";
    value: string;
    alias?: string;
    birthDate?: string;
    displayName?: string;
    groupIds?: string[];
    occupation?: string;
    preferredRoles?: (string | RegExp)[];
    suffix?: string;
}

Hierarchy (view full)

Properties

age arbitrary firstName fullName gender id label lastName type value alias? birthDate? displayName? groupIds? occupation? preferredRoles? suffix?

Properties

age

age: null | number

The age of the person.

Remarks

Age is a number that represents the number of years since the person was born.

arbitrary

arbitrary: undefined

Whether the participant is arbitrary or not. Arbitrary participants are not registered in the system.

firstName

firstName: string

The first name of the person.

Remarks

Some people may have multiple names. In this case, their second or third name can be considered as part of the first name.

Suffixed names should not be included here. Use the suffix property instead.

Example

// No surnames
✖️ "Carl Andrei Deogracias"
✔️ "Carl Andrei"

// No suffixes
✖️ "Anthony James Jr."
✔️ "Anthony James"

// No middle initials and surnames
✖️ "Reynald T. Ycong"
✔️ "Reynald"

fullName

fullName: string

The full name of the person.

Remarks

usually the combination of the first name, last name, and the suffix, if present.

gender

gender: Gender

The gender of the person.

id

id: number

label

label: string

The label of the participant.

lastName

lastName: string

The surname of the person.

Remarks

The family name of the person.

In some cultures, the surname is placed before the first name, but it is still considered as the last name.

Example

"Picones"
"Broncano"
"Fernandez"

type

type

The type of the participant.

value

value: string

The value of the participant.

Optionalalias

alias?: string

The nickname of the person.

Remarks

Used as an additional name for the person.

Stage names, nicknames, and other names is considered as an alias. Therefore, it is best to exclude it in the firstName property.

Example

Instead of "Roland Mon", "RM" can be an alternative.

OptionalbirthDate

birthDate?: string

The birth date of the person in the format "YYYY-MM-DD".

Remarks

Used to calculate the age of the person.

Example

"2003-11-08"

OptionaldisplayName

displayName?: string

Custom display name

Remarks

This is used to display the name of the participant. Can be formulated dynamically based on the participant's properties.

Since

???

OptionalgroupIds

groupIds?: string[]

The group IDs that the participant belongs to.

Remarks

This is used to categorize participants into groups for better organization.

Example

id: "8" -> "Youth Group"
id: "9" -> "Choir"
id: "10" -> "Band"

See

ParticipantGroup

Optionaloccupation

occupation?: string

The occupation of the participant, if any.

Remarks

This is the job or profession of the participant.

Used to provide additional information about the participant that can be used in formulating the display name.

OptionalpreferredRoles

preferredRoles?: (string | RegExp)[]

The preferred roles of the participant.

Optionalsuffix

suffix?: string

The suffix of the person.

Remarks

People may have suffixes in their names. For example, Jr., Sr., and III.

Since

0.9.0

Settings

Member Visibility

On This Page

Properties