Skip to content

Define IDL methods using "method steps" approach #169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 22, 2025
Merged

Define IDL methods using "method steps" approach #169

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 6 additions & 20 deletions api.bs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -551,7 +551,7 @@ used by different [=aggregation services=]. This document defines two protocols:

## Saving Impressions ## {#save-impression-api}

The <dfn method for=PrivateAttribution>saveImpression()</dfn> method requests
The <a method for=PrivateAttribution>saveImpression()</a> method requests
that the [=user agent=] record an [=impression=] in the [=impression store=].

<div class=example id=ex-save-impression>
Expand Down Expand Up @@ -631,15 +631,9 @@ The arguments to <a method for=PrivateAttribution>saveImpression()</a> are as fo
</dd>
</dl>

The <dfn for=PrivateAttribution method>saveImpression(|options|)</dfn> method
causes the user agent to invoke the [=save an impression=] algorithm
with [=this=]'s [=relevant settings object=]
and the provided |options|.


## Requesting Attribution for a Conversion ## {#measure-conversion-api}

The <dfn method for=PrivateAttribution>measureConversion()</dfn> method
The <a method for=PrivateAttribution>measureConversion()</a> method
requests that the [=user agent=] perform [=attribution=] for a [=conversion=],
and return a [=conversion report=].

Expand Down Expand Up @@ -811,12 +805,6 @@ The arguments to <a method for=PrivateAttribution>measureConversion()</a> are as
</dd>
</dl>

The <dfn for=PrivateAttribution method>measureConversion(|options|)</dfn> method
causes the user agent to invoke the [=measure a conversion=] algorithm
with [=this=]'s [=relevant settings object=]
and the provided |options|.


## Permissions Policy Integration ## {#permission-policy}

This specification defines two [=policy-controlled features=]:
Expand Down Expand Up @@ -1219,12 +1207,11 @@ returning an [=epoch index=]:

## Save Impression Algorithm ## {#save-impression-api-operation}

To <dfn>save an impression</dfn>,
given an [=environment settings object=] |settings|
and given <a dictionary lt=PrivateAttributionImpressionOptions>|options|</a>:
The <dfn method for=PrivateAttribution>saveImpression(|options|)</dfn> method steps are:

<!-- TODO: Check the {{PermissionPolicy/save-impression}} policy. -->

1. Let |settings| be [=this=]'s [=relevant settings object=].
1. Collect the implicit API inputs from |settings|:
1. Let |timestamp| be |settings|' [=environment settings object/current wall time=].
1. The [=impression site=] |site| is set to the result of
Expand Down Expand Up @@ -1267,12 +1254,11 @@ API is [[#opt-out|disabled]].

## Measure Conversion Algorithm ## {#measure-conversion-api-operation}

To <dfn>measure a conversion</dfn>,
given a [=environment settings object=] |settings|
and <a dictionary lt=PrivateAttributionConversionOptions>|options|</a>:
The <dfn method for=PrivateAttribution>measureConversion(|options|)</dfn> method steps are:

<!-- TODO: Check the {{PermissionPolicy/measure-conversion}} policy. -->

1. Let |settings| be [=this=]'s [=relevant settings object=].
1. Collect the implicit API inputs from |settings|:
1. Let |now| be |settings|' [=environment settings object/current wall time=].
1. Let |topLevelSite| (the [=conversion site=]) be the result of
Expand Down
Loading