FDO SDK API Reference
    Preparing search index...

    Interface ProfileDefinition<Attributes>

    interface ProfileDefinition<Attributes extends ProfileAttributes> {
        mapping: AttributeToPID<Attributes>;
        pid: string;
        profileAttributePID?: string;
        readableName: string;
    }

    Type Parameters

    Index
    mapping pid profileAttributePID? readableName
    mapping: AttributeToPID<Attributes>

    Maps the readable name of an attribute to its PID

    pid: string

    The PID of this profile

    profileAttributePID?: string

    The PID of the attribute that is used to mark this profile as active for records that use it. When left undefined, no attribute will be used to mark this profile as active.

    // profileAttributePID: "0.SIMPLE/PROFILE"

    myRecord.addProfile(MY_PROFILE, { ... })
    // -> attribute "0.SIMPLE/PROFILE" on myRecord is set to MY_PROFILE.pid
    readableName: string

    The human-readable name of this profile

    Settings
    Member Visibility

    On This Page
    Properties