Skip to main content

salesforce.childrelationship

Home > @runlightyear/salesforce > ChildRelationship

ChildRelationship interface

Signature:
interface ChildRelationship 

Required Properties

PropertyModifiersTypeDescription
cascadeDeletebooleanIndicates whether the child object is deleted when the parent object is deleted (true) or not (false).
childSObjectstringThe name of the object on which there is a foreign key back to the parent sObject.
deprecatedAndHiddenbooleanReserved for future use.
fieldstringThe name of the field that has a foreign key back to the parent sObject.
junctionIdListNamesArray<string>

The names of the lists of junction IDs associated with an object. Each ID represents an object that has a relationship with the associated object.

For more information on JunctionIdList fields, see Field Types.

junctionReferenceToArray<string>

A collection of object names that the polymorphic keys in the junctionIdListNames property can reference.

You can query these object names.

relationshipNamestringThe name of the relationship, usually the plural of the value in childSObject.
restrictedDeletebooleanIndicates whether the parent object can’t be deleted because it is referenced by a child object (true) or not (false).