Interface Profile

A profile of the application.

Remarks

This represents the configuration of the application.

A profile can be exported and imported to share configurations and make it easier to set up the application in different environments.

The application can have multiple profiles, but only one profile can be active at a time.

Since

0.4.0

interface Profile {
    $schema: string;
    lineups: Lineup[];
    metadata: ProfileMetadata;
    participants: {
        entities: EntityRaw[];
        groups: ParticipantGroup[];
        patterns: (Omit<DisplayNamePattern<LineupParticipantPersonPrimitive>, "sequence"> & {
            sequence: SequenceItemLiteral[] | SequenceItemProperty[];
        })[];
        registry: ParticipantPersonRaw[];
    };
    presets: PresetRaw[];
    settings: Settings;
}

Hierarchy (view full)

Properties

$schema lineups metadata participants presets settings

Properties

$schema

$schema: string

The schema of the profile.

Remarks

A placeholder for exporting profile schema.

lineups

lineups: Lineup[]

The collection of lineups

metadata

metadata: ProfileMetadata

Data related to the profile

Remarks

This includes version information and other metadata.

participants

participants: {
    entities: EntityRaw[];
    groups: ParticipantGroup[];
    patterns: (Omit<DisplayNamePattern<LineupParticipantPersonPrimitive>, "sequence"> & {
        sequence: SequenceItemLiteral[] | SequenceItemProperty[];
    })[];
    registry: ParticipantPersonRaw[];
}

Databases related to the profile participants

presets

presets: PresetRaw[]

The collection of presets

settings

settings: Settings

Application settings

Settings

Member Visibility

On This Page

Properties