api/challenges/pronunciation

This file contains the readily available functions which interact with the ITSLanguage pronunciation challenge API.

Source:

Members

(inner, constant) url :string

Source:

The URL for the pronunciation challenge handler(s).

Type:
  • string

Methods

(static) create(challenge) → {Promise}

Source:

Create a new pronunciation challenge.

Parameters:
Name Type Description
challenge Object

The pronunciation challenge to create.
Returns:
  • The pronunciation challenge creation promise.
Type
Promise

(static) deleteChallenge(id) → {Promise}

Source:

Delete the pronunciation challenge with the given ID.

Parameters:
Name Type Description
id string

The ID of the pronunciation challenge to delete.
Returns:
  • The pronunciation delete promise.
Type
Promise

(static) getAll(filtersopt) → {Promise}

Source:

Get a all pronunciation challenges.

By default all pronunciation challenges are fetched though it is allowed to pass filters as a URLSearchParams object.

Parameters:
Name Type Attributes Description
filters URLSearchParams <optional>

The filters to apply to the category list.
Throws:
  • If the given optional filters are not an instance of URLSearchParams.
Type
Promise.<string>
Returns:
  • The promise for the pronunciation challenges.
Type
Promise

(static) getById(id) → {Promise}

Source:

Get a single pronunciation challenge by its ID.

Parameters:
Name Type Description
id string

The ID of the desired pronunciation challenge.
Returns:
  • The promise for the pronunciation challenge.
Type
Promise