Initialization Option Author API

player_templates

Holds custom assess player templates for authors to select from in the Activity editor.

An assess player template is a defined set of Assess API config options which will be used to display the Activity. Custom assess player templates specified here will be included in the list of preconfigured templates available on the Player tab of the Activity editor.

Each array object represents a custom player template.

Values

Request object key config.activity_edit.player_templates

Default: []

Type array[PlayerTemplateObject]

Type definitions

PlayerTemplateObject object

The following properties are supported in each template.
  • name string
    Display name of the template to be shown in the templates list.
  • reference string
    The unique identifier of the player template. Max length for the reference is 150 characters.
  • labelBundle object

    Specifies label bundle config to pass to Assess API. Assess API's default label bundle will be used if not specified.

    See the labelBundle initialization option for Assess API for more information.

  • regions object

    Specifies the regions configuration to pass to Assess API.

    See the regions initialization option for Assess API for more information.

  • navigation object

    Customize various navigational elements within the assessment player.

    See the navigation initialization option for Assess API for more information.