Member Junction
    Preparing search index...

    Type Alias ComponentEntityDataRequirement

    Describes use of a single entity

    type ComponentEntityDataRequirement = {
        description?: string;
        displayFields: string[];
        fieldMetadata: SimpleEntityFieldInfo[];
        filterFields?: string[];
        name: string;
        permissionLevelNeeded: ComponentEntitySimplePermission[];
        sortFields?: string[];
        usageContext?: string;
    }
    Index

    Properties

    description? displayFields fieldMetadata filterFields? name permissionLevelNeeded sortFields? usageContext?

    Properties

    description?: string

    Description of data in the entity

    displayFields: string[]

    Fields to show the user

    fieldMetadata: SimpleEntityFieldInfo[]

    For the set of fields used in the combination of display, filter, and sort, this array is populated with additional metadata about each field. This will NOT include fields that are not used in the component.

    filterFields?: string[]

    Fields to filter on initially or via user interaction.

    name: string

    Name of the entity (unique system-wide)

    permissionLevelNeeded: ComponentEntitySimplePermission[]

    Array of permissions required by the component

    sortFields?: string[]

    Fields to use when sorting

    usageContext?: string

    When/Where/How components should use this data

    Settings

    Member Visibility

    On This Page

    Properties