api/challenges/speech

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

Source:

Members

(inner, constant) url :string

Source:

The URL for the speech challenge handler(s).

Type:
  • string

Methods

(static) create(challenge) → {Promise}

Source:

Create a new speech challenge.

Parameters:
Name Type Description
challenge Object

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

(static) getAll(filtersopt) → {Promise}

Source:

Get a all speech challenges.

By default all speech 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 speech challenges.
Type
Promise

(static) getById(id) → {Promise}

Source:

Get a single speech challenge by its ID.

Parameters:
Name Type Description
id string

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