Interface IH5PQuestionType

interface IH5PQuestionType {
    getAnswerGiven(): boolean;
    getMaxScore(): number;
    getScore(): number;
    getXAPIData(): XAPIData;
    resetTask(): void;
    showSolutions(): void;
}

Index

Methods

getAnswerGiven getMaxScore getScore getXAPIData resetTask showSolutions

Methods

getAnswerGiven

getAnswerGiven(): boolean
Checks if answers for this task has been given, and the program can proceed to calculate scores. Should return false if the user can not proceed yet.

Returns boolean
True if answers has been given

See
https://h5p.org/documentation/developers/contracts#guides-header-1
- Defined in types/Interfaces/IH5PQuestionType.ts:13

getMaxScore

getMaxScore(): number
Calculates the maximum score for this task.

Returns number
Maximum score for this task
See
https://h5p.org/documentation/developers/contracts#guides-header-3
Example
```
If the task has 5 questions, and each question is worth 1 point,
the maximum score is 5.
```
- Defined in types/Interfaces/IH5PQuestionType.ts:40

getScore

getScore(): number
Calculates the user's score for this task, for example correct answers subtracted by wrong answers.

Returns number
User's score for this task
See
https://h5p.org/documentation/developers/contracts#guides-header-2
Example
```
If the task has 5 questions, and the user has answered 3 correctly,
the score is 3.
```
- Defined in types/Interfaces/IH5PQuestionType.ts:27

getXAPIData

getXAPIData(): XAPIData
Retrieves the xAPI data necessary for generating result reports.

Returns XAPIData
See
https://h5p.org/documentation/developers/contracts#guides-header-6
- Defined in types/Interfaces/IH5PQuestionType.ts:62

resetTask

resetTask(): void
Resets the task to its initial state, should also show buttons that were hidden by showSolutions

Returns void
See
https://h5p.org/documentation/developers/contracts#guides-header-5
- Defined in types/Interfaces/IH5PQuestionType.ts:55

showSolutions

showSolutions(): void
Shows the solution for this task. It should also hide all buttons

Returns void
See
https://h5p.org/documentation/developers/contracts#guides-header-4
- Defined in types/Interfaces/IH5PQuestionType.ts:47