MVFv3 API Documentation
    Preparing search index...

    Type Alias NavigationFlagDeclaration

    A NavigationFlagDeclaration describes the relationship between a "key" that a developer might use to wayfind using that flag, and the index and bit position in an object's flags array. Ie, if there is a flag with a key of vip, index 1 and bit position 0, then an item with flags as [0, 0] does not have the flag, [0, 1] does, and [1, 2] or [1, 0] do not.

    NavigationFlagDeclarations also may contain details about the flag, which can be displayed to a user if present.

    type NavigationFlagDeclaration = {
        index: number;
        bit: number;
        details?: {
            description?: string;
            externalId?: string;
            icon?: string;
            name?: string;
            shortName?: string;
        };
    }
    Index

    Properties

    index bit details?

    Properties

    index: number

    The index of the flag in a flags array. ie, 0 means the first bitfield, 1 means the second bitfield, etc.

    bit: number

    The bit position of the flag in a flag's bitfield. ie, 0 means the first bit, 1 means the second bit, etc. A flag bitfield with that bit set to 1 means the flag is present. Other than for Well Known Flags, this is not expected to be durable across different versions of the same MVF.

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

    {@inheritDoc utility-types/details!Details}

    Details

    Settings

    Member Visibility

    On This Page

    Properties