Variable fieldsForRole

Type Declaration

• • (
        role: any,
        mode: any,
        protocol: any,
    ): (
        | {
            enum?: undefined;
            from: string;
            kind: string;
            name: string;
            role: string;
            sensitive?: undefined;
            standard?: undefined;
            what: string;
        }
        | {
            enum?: undefined;
            from: string;
            kind: string;
            name: string;
            role: string;
            sensitive?: undefined;
            standard: boolean;
            what: string;
        }
        | {
            enum?: undefined;
            from: string;
            kind: string;
            name: string;
            role: string;
            sensitive: boolean;
            standard?: undefined;
            what: string;
        }
        | {
            enum: string[];
            from: string;
            kind: string;
            name: string;
            role: string;
            sensitive?: undefined;
            standard?: undefined;
            what: string;
        }
    )[]

  • Returns the editable attributes that apply to a relationship in a role, in schema order.

    Parameters

    • role: any

      the relationship's role

    • mode: any

      set or multi to narrow to one kind of edit, or empty for both

    • protocol: any

      the relationship's protocol, which narrows an ssf one to its Shared Signals fields; empty for the role alone

    Returns (
        | {
            enum?: undefined;
            from: string;
            kind: string;
            name: string;
            role: string;
            sensitive?: undefined;
            standard?: undefined;
            what: string;
        }
        | {
            enum?: undefined;
            from: string;
            kind: string;
            name: string;
            role: string;
            sensitive?: undefined;
            standard: boolean;
            what: string;
        }
        | {
            enum?: undefined;
            from: string;
            kind: string;
            name: string;
            role: string;
            sensitive: boolean;
            standard?: undefined;
            what: string;
        }
        | {
            enum: string[];
            from: string;
            kind: string;
            name: string;
            role: string;
            sensitive?: undefined;
            standard?: undefined;
            what: string;
        }
    )[]

    the schema rows