@instructure/athena-api-client 3.45.0 → 3.46.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -16,13 +16,13 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface StudyObjectiveAccess {
|
|
18
18
|
/**
|
|
19
|
-
* What the Canvas item's course gives Athena to go on: 'grounded' (
|
|
19
|
+
* What the Canvas item's course gives Athena to go on: 'grounded' (the course has material: a syllabus, the item's own text, readable course files, or, when Canvas refused the course files list, files it publishes through Modules, locked for this learner or not), 'unknown' (Athena can't tell; see unknownReason), 'unreadable' (nothing readable, but locked files or external-tool items exist that Athena cannot open), or 'thin' (the item's title and dates only).
|
|
20
20
|
* @type {string}
|
|
21
21
|
* @memberof StudyObjectiveAccess
|
|
22
22
|
*/
|
|
23
23
|
state: StudyObjectiveAccessStateEnum;
|
|
24
24
|
/**
|
|
25
|
-
* Why state is 'unknown'; null otherwise. 'pages-only': the course's only candidate material is module pages, which Athena counts but does not open. 'listing-denied': Canvas refused the files or modules listing (for example a hidden Files tab) and nothing
|
|
25
|
+
* Why state is 'unknown'; null otherwise. 'pages-only': the course's only candidate material is module pages, which Athena counts but does not open. 'listing-denied': Canvas refused the files or modules listing (for example a hidden Files tab) and nothing else grounds the course, so it can't say what that listing holds.
|
|
26
26
|
* @type {string}
|
|
27
27
|
* @memberof StudyObjectiveAccess
|
|
28
28
|
*/
|
|
@@ -70,7 +70,7 @@ export interface StudyObjectiveAccess {
|
|
|
70
70
|
*/
|
|
71
71
|
externalToolItemCount: number | null;
|
|
72
72
|
/**
|
|
73
|
-
*
|
|
73
|
+
* Files in the module that holds this item (a quiz or assignment), locked for the learner or not: checked against the course files list, or, when Canvas refused that list, counted from the module's own File items. Null when the item is in no module, is another kind of item, or modules could not be listed, and on facts read before rule 6 (which counted only the files their reader could open).
|
|
74
74
|
* @type {number}
|
|
75
75
|
* @memberof StudyObjectiveAccess
|
|
76
76
|
*/
|
|
@@ -82,19 +82,25 @@ export interface StudyObjectiveAccess {
|
|
|
82
82
|
*/
|
|
83
83
|
moduleSiblingPageCount: number | null;
|
|
84
84
|
/**
|
|
85
|
-
*
|
|
85
|
+
* Files the course publishes through Modules (File items of a supported type, one per file), locked for the learner or not, so no learner's module locks change it (a module assigned to some sections lists its files only to them). The file count to name only when readableFileCount is null (Canvas refused the course files list, e.g. a hidden Files tab); never add it to readableFileCount, since module links point at listed files. Null when modules could not be listed, and on facts read before rule 4.
|
|
86
|
+
* @type {number}
|
|
87
|
+
* @memberof StudyObjectiveAccess
|
|
88
|
+
*/
|
|
89
|
+
moduleFileCount: number | null;
|
|
90
|
+
/**
|
|
91
|
+
* Always null. The readable/locked split of moduleFileCount is the one the learner whose read stored these facts saw (a module lock follows each learner's progress), so it is not returned; read moduleFileCount. Kept so clients built against it keep decoding.
|
|
86
92
|
* @type {number}
|
|
87
93
|
* @memberof StudyObjectiveAccess
|
|
88
94
|
*/
|
|
89
95
|
moduleReadableFileCount: number | null;
|
|
90
96
|
/**
|
|
91
|
-
*
|
|
97
|
+
* Always null; see moduleReadableFileCount.
|
|
92
98
|
* @type {number}
|
|
93
99
|
* @memberof StudyObjectiveAccess
|
|
94
100
|
*/
|
|
95
101
|
moduleLockedFileCount: number | null;
|
|
96
102
|
/**
|
|
97
|
-
*
|
|
103
|
+
* The rule that produced `state`, for joining client analytics to the rule that was live. Facts stored under rule 4 or later are decided again by the current rule when read (every input it needs is stored), so they report the current rule; facts from earlier rules keep the state and version they were stored with.
|
|
98
104
|
* @type {number}
|
|
99
105
|
* @memberof StudyObjectiveAccess
|
|
100
106
|
*/
|
|
@@ -77,6 +77,8 @@ export function instanceOfStudyObjectiveAccess(value) {
|
|
|
77
77
|
return false;
|
|
78
78
|
if (!('moduleSiblingPageCount' in value) || value['moduleSiblingPageCount'] === undefined)
|
|
79
79
|
return false;
|
|
80
|
+
if (!('moduleFileCount' in value) || value['moduleFileCount'] === undefined)
|
|
81
|
+
return false;
|
|
80
82
|
if (!('moduleReadableFileCount' in value) || value['moduleReadableFileCount'] === undefined)
|
|
81
83
|
return false;
|
|
82
84
|
if (!('moduleLockedFileCount' in value) || value['moduleLockedFileCount'] === undefined)
|
|
@@ -110,6 +112,7 @@ export function StudyObjectiveAccessFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
110
112
|
'externalToolItemCount': json['externalToolItemCount'],
|
|
111
113
|
'moduleSiblingFileCount': json['moduleSiblingFileCount'],
|
|
112
114
|
'moduleSiblingPageCount': json['moduleSiblingPageCount'],
|
|
115
|
+
'moduleFileCount': json['moduleFileCount'],
|
|
113
116
|
'moduleReadableFileCount': json['moduleReadableFileCount'],
|
|
114
117
|
'moduleLockedFileCount': json['moduleLockedFileCount'],
|
|
115
118
|
'ruleVersion': json['ruleVersion'],
|
|
@@ -137,6 +140,7 @@ export function StudyObjectiveAccessToJSONTyped(value, ignoreDiscriminator = fal
|
|
|
137
140
|
'externalToolItemCount': value['externalToolItemCount'],
|
|
138
141
|
'moduleSiblingFileCount': value['moduleSiblingFileCount'],
|
|
139
142
|
'moduleSiblingPageCount': value['moduleSiblingPageCount'],
|
|
143
|
+
'moduleFileCount': value['moduleFileCount'],
|
|
140
144
|
'moduleReadableFileCount': value['moduleReadableFileCount'],
|
|
141
145
|
'moduleLockedFileCount': value['moduleLockedFileCount'],
|
|
142
146
|
'ruleVersion': value['ruleVersion'],
|
|
@@ -16,13 +16,13 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface StudyObjectiveAccess {
|
|
18
18
|
/**
|
|
19
|
-
* What the Canvas item's course gives Athena to go on: 'grounded' (
|
|
19
|
+
* What the Canvas item's course gives Athena to go on: 'grounded' (the course has material: a syllabus, the item's own text, readable course files, or, when Canvas refused the course files list, files it publishes through Modules, locked for this learner or not), 'unknown' (Athena can't tell; see unknownReason), 'unreadable' (nothing readable, but locked files or external-tool items exist that Athena cannot open), or 'thin' (the item's title and dates only).
|
|
20
20
|
* @type {string}
|
|
21
21
|
* @memberof StudyObjectiveAccess
|
|
22
22
|
*/
|
|
23
23
|
state: StudyObjectiveAccessStateEnum;
|
|
24
24
|
/**
|
|
25
|
-
* Why state is 'unknown'; null otherwise. 'pages-only': the course's only candidate material is module pages, which Athena counts but does not open. 'listing-denied': Canvas refused the files or modules listing (for example a hidden Files tab) and nothing
|
|
25
|
+
* Why state is 'unknown'; null otherwise. 'pages-only': the course's only candidate material is module pages, which Athena counts but does not open. 'listing-denied': Canvas refused the files or modules listing (for example a hidden Files tab) and nothing else grounds the course, so it can't say what that listing holds.
|
|
26
26
|
* @type {string}
|
|
27
27
|
* @memberof StudyObjectiveAccess
|
|
28
28
|
*/
|
|
@@ -70,7 +70,7 @@ export interface StudyObjectiveAccess {
|
|
|
70
70
|
*/
|
|
71
71
|
externalToolItemCount: number | null;
|
|
72
72
|
/**
|
|
73
|
-
*
|
|
73
|
+
* Files in the module that holds this item (a quiz or assignment), locked for the learner or not: checked against the course files list, or, when Canvas refused that list, counted from the module's own File items. Null when the item is in no module, is another kind of item, or modules could not be listed, and on facts read before rule 6 (which counted only the files their reader could open).
|
|
74
74
|
* @type {number}
|
|
75
75
|
* @memberof StudyObjectiveAccess
|
|
76
76
|
*/
|
|
@@ -82,19 +82,25 @@ export interface StudyObjectiveAccess {
|
|
|
82
82
|
*/
|
|
83
83
|
moduleSiblingPageCount: number | null;
|
|
84
84
|
/**
|
|
85
|
-
*
|
|
85
|
+
* Files the course publishes through Modules (File items of a supported type, one per file), locked for the learner or not, so no learner's module locks change it (a module assigned to some sections lists its files only to them). The file count to name only when readableFileCount is null (Canvas refused the course files list, e.g. a hidden Files tab); never add it to readableFileCount, since module links point at listed files. Null when modules could not be listed, and on facts read before rule 4.
|
|
86
|
+
* @type {number}
|
|
87
|
+
* @memberof StudyObjectiveAccess
|
|
88
|
+
*/
|
|
89
|
+
moduleFileCount: number | null;
|
|
90
|
+
/**
|
|
91
|
+
* Always null. The readable/locked split of moduleFileCount is the one the learner whose read stored these facts saw (a module lock follows each learner's progress), so it is not returned; read moduleFileCount. Kept so clients built against it keep decoding.
|
|
86
92
|
* @type {number}
|
|
87
93
|
* @memberof StudyObjectiveAccess
|
|
88
94
|
*/
|
|
89
95
|
moduleReadableFileCount: number | null;
|
|
90
96
|
/**
|
|
91
|
-
*
|
|
97
|
+
* Always null; see moduleReadableFileCount.
|
|
92
98
|
* @type {number}
|
|
93
99
|
* @memberof StudyObjectiveAccess
|
|
94
100
|
*/
|
|
95
101
|
moduleLockedFileCount: number | null;
|
|
96
102
|
/**
|
|
97
|
-
*
|
|
103
|
+
* The rule that produced `state`, for joining client analytics to the rule that was live. Facts stored under rule 4 or later are decided again by the current rule when read (every input it needs is stored), so they report the current rule; facts from earlier rules keep the state and version they were stored with.
|
|
98
104
|
* @type {number}
|
|
99
105
|
* @memberof StudyObjectiveAccess
|
|
100
106
|
*/
|
|
@@ -85,6 +85,8 @@ function instanceOfStudyObjectiveAccess(value) {
|
|
|
85
85
|
return false;
|
|
86
86
|
if (!('moduleSiblingPageCount' in value) || value['moduleSiblingPageCount'] === undefined)
|
|
87
87
|
return false;
|
|
88
|
+
if (!('moduleFileCount' in value) || value['moduleFileCount'] === undefined)
|
|
89
|
+
return false;
|
|
88
90
|
if (!('moduleReadableFileCount' in value) || value['moduleReadableFileCount'] === undefined)
|
|
89
91
|
return false;
|
|
90
92
|
if (!('moduleLockedFileCount' in value) || value['moduleLockedFileCount'] === undefined)
|
|
@@ -118,6 +120,7 @@ function StudyObjectiveAccessFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
118
120
|
'externalToolItemCount': json['externalToolItemCount'],
|
|
119
121
|
'moduleSiblingFileCount': json['moduleSiblingFileCount'],
|
|
120
122
|
'moduleSiblingPageCount': json['moduleSiblingPageCount'],
|
|
123
|
+
'moduleFileCount': json['moduleFileCount'],
|
|
121
124
|
'moduleReadableFileCount': json['moduleReadableFileCount'],
|
|
122
125
|
'moduleLockedFileCount': json['moduleLockedFileCount'],
|
|
123
126
|
'ruleVersion': json['ruleVersion'],
|
|
@@ -145,6 +148,7 @@ function StudyObjectiveAccessToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
145
148
|
'externalToolItemCount': value['externalToolItemCount'],
|
|
146
149
|
'moduleSiblingFileCount': value['moduleSiblingFileCount'],
|
|
147
150
|
'moduleSiblingPageCount': value['moduleSiblingPageCount'],
|
|
151
|
+
'moduleFileCount': value['moduleFileCount'],
|
|
148
152
|
'moduleReadableFileCount': value['moduleReadableFileCount'],
|
|
149
153
|
'moduleLockedFileCount': value['moduleLockedFileCount'],
|
|
150
154
|
'ruleVersion': value['ruleVersion'],
|