ContextQMD
Back to Content

Fence

files/en-us/web/api/fence/index.md

latest2.4 KB
Original Source

{{SeeCompatTable}}{{APIRef("Fenced Frame API")}}

The Fence interface of the {{domxref("Fenced Frame API", "Fenced Frame API", "", "nocode")}} contains several functions relevant to {{htmlelement("fencedframe")}} functionality.

Fence objects are accessed through the {{domxref("Window.fence")}} property, but they are only available to documents embedded inside {{htmlelement("fencedframe")}}s (loaded via {{domxref("FencedFrameConfig")}}s) or {{htmlelement("iframe")}}s (loaded via opaque URNs).

[!NOTE] See How do <fencedframe>s work? for some description around FencedFrameConfigs and opaque URNs.

{{InheritanceDiagram}}

Instance methods

  • {{domxref("Fence.getNestedConfigs", "getNestedConfigs()")}} {{Experimental_Inline}}
    • : Returns the {{domxref("FencedFrameConfig")}}s loaded into <fencedframe>s embedded inside the current <fencedframe>.
  • {{domxref("Fence.reportEvent", "reportEvent()")}} {{Experimental_Inline}}
    • : Triggers the submission of report data via a beacon to one ore more specific URLs registered via the {{domxref("InterestGroupReportingScriptRunnerGlobalScope.registerAdBeacon", "registerAdBeacon()")}} method of the Protected Audience API, for the purpose of collecting ad auction results.
  • {{domxref("Fence.setReportEventDataForAutomaticBeacons", "setReportEventDataForAutomaticBeacons()")}} {{Experimental_Inline}}
    • : Specifies event data that will be sent when a navigation occurs inside a <fencedframe>. This data will be sent via an automatic beacon to one or more specific URLs registered via the {{domxref("InterestGroupReportingScriptRunnerGlobalScope.registerAdBeacon", "registerAdBeacon()")}} method of the Protected Audience API, for the purpose of collecting reporting data for ad auction results.

Examples

js
window.fence.reportEvent({
  eventType: "click",
  eventData: JSON.stringify({ clickX: "123", clickY: "456" }),
  destination: ["buyer", "seller"],
});

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also