Skip to content
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

Jump to bottom

doc: add getEvents method to the public API #2322

Merged
merged 2 commits into from
Sep 17, 2020
Merged

doc: add getEvents method to the public API #2322

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
59c934c
feat: add getEvents method to the public API https://github.com/prebi…
gpolaert Sep 9, 2020
44bb08f
Update publisher-api-reference.md
gpolaert Sep 10, 2020
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
7 changes: 6 additions & 1 deletion dev-docs/publisher-api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ This page has documentation for the public API methods of Prebid.js.
* [.getAdserverTargetingForAdUnitCode([adUnitCode])](#module_pbjs.getAdserverTargetingForAdUnitCode)
* [.getBidResponses()](#module_pbjs.getBidResponses)
* [.getBidResponsesForAdUnitCode(adUnitCode)](#module_pbjs.getBidResponsesForAdUnitCode)
* [.getEvents()](#module_pbjs.onEvent)
* [.getHighestCpmBids([adUnitCode])](#module_pbjs.getHighestCpmBids)
* [.getAllWinningBids()](#module_pbjs.getAllWinningBids)
* [.getAllPrebidWinningBids()](#module_pbjs.getAllPrebidWinningBids)
Expand Down Expand Up @@ -1179,8 +1180,12 @@ If a custom adServerTargeting function can return an empty value, this boolean f

### pbjs.offEvent(event, handler, id)

### pbjs.getEvents() ⇒ `Array`

The methods `onEvent` and `offEvent` are provided for you to register
a callback to handle a Prebid.js event.
a callback to handle a Prebid.js event.

The `getEvents` method returns a copy of all emitted events.

The optional `id` parameter provides more finely-grained event
callback registration. This makes it possible to register callback
Expand Down