exportRelationshipInstance MethodProtected

Applies exclusion rules and handler callbacks to an already-hydrated relationship instance.

exportRelationshipInstance(relationship: Relationship, isUpdate: boolean, endpointFedGuids?: RelationshipEndpointFederationGuids): Promise<void>

@note This is the common protected hook used by both exportRelationship and exportRelationships. Most consumers should customize IModelExportHandler instead.

Parameter Type Description
relationship Relationship  
isUpdate boolean  
endpointFedGuids RelationshipEndpointFederationGuids The FederationGuids of the relationship's source and target elements, passed to onExportRelationship.

Returns - Promise

Defined in

Last Updated: 06 November, 2026