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

feat: ads error interface #568

Merged
merged 9 commits into from
Mar 4, 2024
Merged

feat: ads error interface #568

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
692a891
feat: ads error interface
wseymour15 Feb 21, 2024
1224d5e
minor comment changes
wseymour15 Feb 26, 2024
fb33c84
update jsdoc
wseymour15 Feb 26, 2024
d6cb50e
update error function to handle null
wseymour15 Feb 26, 2024
f9b1e45
add tests for error interface
wseymour15 Feb 28, 2024
e39e5b9
add error documentation
wseymour15 Feb 29, 2024
2a5389f
changes based on comments
wseymour15 Mar 4, 2024
b8e79ae
update vjs to 8.11.6
wseymour15 Mar 4, 2024
56582d8
additional metadata for resume content error
wseymour15 Mar 4, 2024
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
32 changes: 32 additions & 0 deletions docs/integrator/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,38 @@ if (player.ads.inAdBreak()) {
}
```

### error

Advanced function. Gets, sets, and clears a non-critical ads error in videojs-contrib-ads.

The error will be in the form of an object. This object must contain a `errorType` string, and can also include zero to many custom properties.
```js
{
errorType: 'ads-error-type',
// The key can have any name, and the value can have any type of data.
customData: 'custom-data'
...
}
```

To get the current ads error, the `error` function should be called with no parameters. Returns `null` if there is no error.
```js
const currentAd = player.ads.error();
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const currentAd = player.ads.error();
const currentAdError = player.ads.error();

```

To set the current ads error, the `error` function should be called with a valid error.
```js
const ad = { errorType: 'ads-error-type' }
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
const ad = { errorType: 'ads-error-type' }
const adError = { errorType: 'ads-error-type' }


player.ads.error(ad);
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
player.ads.error(ad);
player.ads.error(adError);

```

To clear the current ads error, the `error` function should be called with a `null` value.
This value will also be cleared if an invalid error is passed to the function.
```js
player.ads.error(null);
```

## Deprecated

The following are slated for removal from contrib-ads and will have no special behavior once removed. These should no longer be used in integrating ad plugins. Replacements are provided for matching functionality that will continue to be supported.
Expand Down
Loading