MVFv3 API Documentation
    Preparing search index...

    Type Alias WithDetails

    Adds a Details object to a schema, in the standard details property.

    This should be done rather than adding ANY property inside of details directly to an object.

    Ie: If an extension has an object that should have a name property, add withDetails instead of adding name directly.

    Using WithDetails, all properties of the Details object are optional.

    WithRequiredDetails for a way to add Details where some properties are required.

    type WithDetails = {
        details?: {
            description?: string;
            externalId?: string;
            icon?: string;
            name?: string;
            shortName?: string;
        };
    }
    Index

    Properties

    details?

    Properties

    details?: {
        description?: string;
        externalId?: string;
        icon?: string;
        name?: string;
        shortName?: string;
    }

    {@inheritDoc utility-types/details!Details}

    Type declaration

    • Optionaldescription?: string

      A description of the entity.

    • OptionalexternalId?: string

      An identifier that can be used to link this entity to data outside of the MVF.

    • Optionalicon?: string

      A URL to an icon for the entity.

    • Optionalname?: string

      The name of the entity.

    • OptionalshortName?: string

      A short name for the entity. Usually a handful characters (eg; R303, F1, L, etc.) For display in places a full name would be too long or cumbersome.

    Details

    Settings

    Member Visibility

    On This Page

    Properties