Provides an interface for a tool type in the Moodle server.
- Source:
- Since:
- 3.1
- Copyright:
- 2015 Ryan Wyllie
- 2015 Ryan Wyllie
- License:
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
Members
(inner) constants
- Source:
Tool type constants.
Methods
(inner) create(args) → {Promise}
- Source:
Create a tool type in Moodle.
The promise will fail if the URL is not a cartridge, so you must handle the fail result.
See also: mod/lti/classes/external.php create_tool_type_parameters()
Parameters:
| Name | Type | Description |
|---|---|---|
args |
Object | Tool type properties |
Returns:
jQuery Deferred object
- Type
- Promise
(inner) delete(id) → {Promise}
- Source:
Delete a tool type from Moodle.
Parameters:
| Name | Type | Description |
|---|---|---|
id |
Integer | Tool type ID |
Returns:
jQuery Deferred object
- Type
- Promise
(inner) isCartridge(url) → {Promise}
- Source:
Check if the given URL is a cartridge URL.
The promise will fail if the URL is unreachable, so you must handle the fail result.
Parameters:
| Name | Type | Description |
|---|---|---|
url |
String |
Returns:
jQuery Deferred object
- Type
- Promise
(inner) query(args) → {Promise}
- Source:
Get a list of tool types from Moodle for the given search args.
See also: mod/lti/classes/external.php get_tool_types_parameters()
Parameters:
| Name | Type | Description |
|---|---|---|
args |
Object | Search parameters |
Returns:
jQuery Deferred object
- Type
- Promise
(inner) query(id) → {Promise}
- Source:
Get a list of tool types from Moodle for the given tool proxy id.
Parameters:
| Name | Type | Description |
|---|---|---|
id |
Integer | Tool type ID |
Returns:
jQuery Deferred object
- Type
- Promise
(inner) update(args) → {Promise}
- Source:
Update a tool type in Moodle.
See also: mod/lti/classes/external.php update_tool_type_parameters()
Parameters:
| Name | Type | Description |
|---|---|---|
args |
Object | Tool type properties |
Returns:
jQuery Deferred object
- Type
- Promise