DXNoteClient
This class is responsible for making requests to the note API.
You will need to enable the "Training" scope for your app in the developer dashboard before using the course API.
Properties
Singleton instance of DXNoteClient
. You will access all the available DXNoteClient
methods through this instance.
Methods
createNote
Creates a note.
The following parameters allow the API to automatically add additional metadata to a note:
if a lessonId is specified, the lesson's course ID is added.
if a classId is specified, the class's course ID is added.
if a studentId is specified, the student's user profile ID, class ID, and course IDs are added.
When adding notes for the MOTAR Training Dashboard, you must include a student ID and a lesson ID.
Parameter | Type | Description |
text |
| Text of note. |
lessonId |
| Id of lesson to which this note refers. |
userId |
| Id of user profile to whom this note refers. |
classId |
| Id of class to which this note refers. |
studentId |
| Id of student to whom this note refers. |
courseId |
| Id of student to whom this note refers. |
completion |
| Closure invoked when the request finishes. Called with an |
getNote
Retrieves a specific note by ID.
Parameter | Type | Description |
noteId |
| ID of the note to return. |
completion |
| Closure invoked when the request finishes. Called with an |
getNoteList
Retrieves all notes from the specified category or categories.
Parameter | Type | Description |
lessonId |
| A lesson ID to which the desired notes are related. |
userId |
| A user account ID to whom the notes are related. |
classId |
| A class ID to which the notes are related. |
studentId |
| A student ID to whom the notes are related. |
courseId |
| A course ID to which the desired notes are related. |
completion |
| Closure invoked when the request finishes. Called with an |
deleteNote
Deletes a note by ID.
Parameter | Type | Description |
noteId |
| ID of the note to be deleted. |
completion |
| Closure invoked when the request finishes. Called with an |
Last updated