api/groups

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

Users can be part of zero or multiple groups.

Source:
See:

Members

(inner, constant) url :string

Source:

The URL for the group handler(s).

Type:
  • string

Methods

(static) create(group) → {Promise}

Source:

Create a new group.

Parameters:
Name Type Description
group Object

The group to create.

Properties
Name Type Attributes Description
id string <optional>

A unique identifier. If none is given, one is generated.
name Array

The name of the group.
Returns:
  • The group creation promise.
Type
Promise

(static) getAll(filtersopt) → {Promise}

Source:

Get a all groups.

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

(static) getById(id) → {Promise}

Source:

Get a single group by its ID.

Parameters:
Name Type Description
id string

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