Skip to content

Commit

Permalink
Major version/framework bump for breaking changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
joe-allen-89 committed Apr 25, 2022
1 parent 2ff3e0e commit 9c62191
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**xAPI** is an *extension* intended for use with the [Adapt framework](https://github.com/adaptlearning/adapt_framework) version 3.0 or greater to pass Experience API (xAPI) statements between the Adapt content and a Learning Record Store (LRS), such as [Learning Locker®](https://learninglocker.net/). It is compatible with both the Adapt Framework and the Adapt Authoring Tool.

From this point on, the README assumes a certain level of familiarity with the xAPI and the philosophy behind it. If the xAPI specification is new to you, please start with the documentation at [xapi.com](https://xapi.com/overview/) before continuing.
From this point on, the README assumes a certain level of familiarity with the xAPI and the philosophy behind it. If the xAPI specification is new to you, please start with the documentation at [xapi.com](https://xapi.com/overview/) before continuing.

## Configuration
Some setup is required in order to configure the xAPI extension. If using a standalone Adapt Framework, refer to [example.json](https://github.com/adaptlearning/adapt-contrib-xapi/blob/master/example.json) for a JSON snippet which should be added to your course's config.json. If using the Authoring tool you can configure the following attributes:
Expand All @@ -11,7 +11,7 @@ Some setup is required in order to configure the xAPI extension. If using a sta
|--|--|--|
|Is Enabled| `false` | Set to `true` to enable the extension
|Specification | `xApi` | This must be set
|Endpoint| | URL to the LRS endpoint
|Endpoint| | URL to the LRS endpoint
|User (or Key)| | This can be configured in your LRS, or omit if using ADL Launch mechanism
|Password (or Secret)| | (as above)
|Verb language | `en-US`| Indicates the language of the verbs which will be passed to the LRS
Expand All @@ -20,7 +20,7 @@ Some setup is required in order to configure the xAPI extension. If using a sta
|Use registration| `false` | Uses the `registration` parameter defined by the launch mechanism for calls to the State API
|LRS connection failure behaviour | Show errors | Indicates what should happen when the course cannot connect to the LRS
|Component blacklist | `blank,graphic` | A comma-separated list of components which should not send statements. Set this to an empty string if all components should send a statement.

By default the xAPI extension listens for the following *core* events. Those without an asterisk (*) can be toggled via configuration:

| Object |Event |
Expand Down Expand Up @@ -61,7 +61,7 @@ Note that the xAPI extension works well with the core Assessment extension. The
## Events
The following events are triggered by the xAPI extension:

| Event | Description | Parameter(s) |
| Event | Description | Parameter(s) |
|--|--|--|
|`xapi:lrs:initialize:error`|Triggered when the plugin fails to initialize| An `error` object|
|`xapi:lrs:initialize:success`|Triggered when the plugin successfully establishes connectivity with the LRS | - |
Expand Down Expand Up @@ -125,5 +125,5 @@ Adapt.on('xapi:preSendStatement', function(statement) {

----------------------------

**Version number:** 0.9.5 <a href="https://community.adaptlearning.org/" target="_blank"><img src="https://github.com/adaptlearning/documentation/blob/master/04_wiki_assets/plug-ins/images/adapt-logo-mrgn-lft.jpg" alt="adapt learning logo" align="right"></a>
**Framework versions:** 5.8.0+
**Version number:** 1.0.0 <a href="https://community.adaptlearning.org/" target="_blank"><img src="https://github.com/adaptlearning/documentation/blob/master/04_wiki_assets/plug-ins/images/adapt-logo-mrgn-lft.jpg" alt="adapt learning logo" align="right"></a>
**Framework versions:** 5.19.1+
2 changes: 1 addition & 1 deletion bower.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "adapt-contrib-xapi",
"version": "0.9.5",
"version": "1.0.0",
"framework": ">=5.19.1",
"homepage": "https://github.com/adaptlearning/adapt-contrib-xapi",
"authors": [
Expand Down

0 comments on commit 9c62191

Please sign in to comment.