Delete data of a related object.

Parameters

Description of param Properties

Property	Description	Type	Required	Remarks
objApiName	Related object apiName	String	Yes
relatedFieldName	Related field apiName	String	Yes
recordType	Record type	String	No	Delete data of the specified record type
dataIndexs	Data index list	Array	No	Delete data of specified indexes

Return Value

Returns the deleted related object data list.

Code Example

{
    event: "form.render.end",
    functional: function (pluginExecResult, options) {
        let {dataUpdater}=options;
        // Delete all related object data
        let delAll = dataUpdater.delRelatedDatas({
            objApiName: "relObj",
            relatedFieldName: "relField"
        });
        // Delete data of the specified record type
        let delType = dataUpdater.delRelatedDatas({
            objApiName: "relObj",
            relatedFieldName: "relField",
            recordType: "rt2"
        });
        // Delete data of the specified dataIndex
        let delIdx = dataUpdater.delRelatedDatas({
            objApiName: "relObj",
            relatedFieldName: "relField",
            dataIndexs: ["idx1"]
        });
    }
},

Notes

• If only objApiName and relatedFieldName are passed, all related object data will be deleted.
• If only objApiName, relatedFieldName, and recordType are passed, data of the specified record type will be deleted.
• If only objApiName, relatedFieldName, and dataIndexs are passed, data of the specified indexes will be deleted.
• If required parameters are missing, no operation will be performed.