OLD | NEW |
1 // This is a generated file (see the discoveryapis_generator project). | 1 // This is a generated file (see the discoveryapis_generator project). |
2 | 2 |
3 library googleapis.classroom.v1; | 3 library googleapis.classroom.v1; |
4 | 4 |
5 import 'dart:core' as core; | 5 import 'dart:core' as core; |
6 import 'dart:async' as async; | 6 import 'dart:async' as async; |
7 import 'dart:convert' as convert; | 7 import 'dart:convert' as convert; |
8 | 8 |
9 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons; | 9 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons; |
10 import 'package:http/http.dart' as http; | 10 import 'package:http/http.dart' as http; |
(...skipping 836 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
847 * the requested course or for access errors. | 847 * the requested course or for access errors. |
848 * * `INVALID_ARGUMENT` if the request is malformed. | 848 * * `INVALID_ARGUMENT` if the request is malformed. |
849 * * `NOT_FOUND` if the requested course does not exist. | 849 * * `NOT_FOUND` if the requested course does not exist. |
850 * | 850 * |
851 * Request parameters: | 851 * Request parameters: |
852 * | 852 * |
853 * [courseId] - Identifier of the course. | 853 * [courseId] - Identifier of the course. |
854 * This identifier can be either the Classroom-assigned identifier or an | 854 * This identifier can be either the Classroom-assigned identifier or an |
855 * alias. | 855 * alias. |
856 * | 856 * |
| 857 * [pageSize] - Maximum number of items to return. Zero or unspecified |
| 858 * indicates that the |
| 859 * server may assign a maximum. |
| 860 * |
| 861 * The server may return fewer than the specified number of results. |
| 862 * |
| 863 * [courseWorkStates] - Restriction on the work status to return. Only |
| 864 * courseWork that matches |
| 865 * is returned. If unspecified, items with a work status of `PUBLISHED` |
| 866 * is returned. |
| 867 * |
857 * [pageToken] - nextPageToken | 868 * [pageToken] - nextPageToken |
858 * value returned from a previous | 869 * value returned from a previous |
859 * list call, | 870 * list call, |
860 * indicating that the subsequent page of results should be returned. | 871 * indicating that the subsequent page of results should be returned. |
861 * | 872 * |
862 * The list request | 873 * The list request |
863 * must be otherwise identical to the one that resulted in this token. | 874 * must be otherwise identical to the one that resulted in this token. |
864 * | 875 * |
865 * [orderBy] - Optional sort ordering for results. A comma-separated list of | 876 * [orderBy] - Optional sort ordering for results. A comma-separated list of |
866 * fields with | 877 * fields with |
867 * an optional sort direction keyword. Supported fields are `updateTime` | 878 * an optional sort direction keyword. Supported fields are `updateTime` |
868 * and `dueDate`. Supported direction keywords are `asc` and `desc`. | 879 * and `dueDate`. Supported direction keywords are `asc` and `desc`. |
869 * If not specified, `updateTime desc` is the default behavior. | 880 * If not specified, `updateTime desc` is the default behavior. |
870 * Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc` | 881 * Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc` |
871 * | 882 * |
872 * [pageSize] - Maximum number of items to return. Zero or unspecified | |
873 * indicates that the | |
874 * server may assign a maximum. | |
875 * | |
876 * The server may return fewer than the specified number of results. | |
877 * | |
878 * [courseWorkStates] - Restriction on the work status to return. Only | |
879 * courseWork that matches | |
880 * is returned. If unspecified, items with a work status of `PUBLISHED` | |
881 * is returned. | |
882 * | |
883 * Completes with a [ListCourseWorkResponse]. | 883 * Completes with a [ListCourseWorkResponse]. |
884 * | 884 * |
885 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 885 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
886 * error. | 886 * error. |
887 * | 887 * |
888 * If the used [http.Client] completes with an error when making a REST call, | 888 * If the used [http.Client] completes with an error when making a REST call, |
889 * this method will complete with the same error. | 889 * this method will complete with the same error. |
890 */ | 890 */ |
891 async.Future<ListCourseWorkResponse> list(core.String courseId, {core.String p
ageToken, core.String orderBy, core.int pageSize, core.List<core.String> courseW
orkStates}) { | 891 async.Future<ListCourseWorkResponse> list(core.String courseId, {core.int page
Size, core.List<core.String> courseWorkStates, core.String pageToken, core.Strin
g orderBy}) { |
892 var _url = null; | 892 var _url = null; |
893 var _queryParams = new core.Map(); | 893 var _queryParams = new core.Map(); |
894 var _uploadMedia = null; | 894 var _uploadMedia = null; |
895 var _uploadOptions = null; | 895 var _uploadOptions = null; |
896 var _downloadOptions = commons.DownloadOptions.Metadata; | 896 var _downloadOptions = commons.DownloadOptions.Metadata; |
897 var _body = null; | 897 var _body = null; |
898 | 898 |
899 if (courseId == null) { | 899 if (courseId == null) { |
900 throw new core.ArgumentError("Parameter courseId is required."); | 900 throw new core.ArgumentError("Parameter courseId is required."); |
901 } | 901 } |
| 902 if (pageSize != null) { |
| 903 _queryParams["pageSize"] = ["${pageSize}"]; |
| 904 } |
| 905 if (courseWorkStates != null) { |
| 906 _queryParams["courseWorkStates"] = courseWorkStates; |
| 907 } |
902 if (pageToken != null) { | 908 if (pageToken != null) { |
903 _queryParams["pageToken"] = [pageToken]; | 909 _queryParams["pageToken"] = [pageToken]; |
904 } | 910 } |
905 if (orderBy != null) { | 911 if (orderBy != null) { |
906 _queryParams["orderBy"] = [orderBy]; | 912 _queryParams["orderBy"] = [orderBy]; |
907 } | 913 } |
908 if (pageSize != null) { | |
909 _queryParams["pageSize"] = ["${pageSize}"]; | |
910 } | |
911 if (courseWorkStates != null) { | |
912 _queryParams["courseWorkStates"] = courseWorkStates; | |
913 } | |
914 | 914 |
915 _url = 'v1/courses/' + commons.Escaper.ecapeVariable('$courseId') + '/course
Work'; | 915 _url = 'v1/courses/' + commons.Escaper.ecapeVariable('$courseId') + '/course
Work'; |
916 | 916 |
917 var _response = _requester.request(_url, | 917 var _response = _requester.request(_url, |
918 "GET", | 918 "GET", |
919 body: _body, | 919 body: _body, |
920 queryParams: _queryParams, | 920 queryParams: _queryParams, |
921 uploadOptions: _uploadOptions, | 921 uploadOptions: _uploadOptions, |
922 uploadMedia: _uploadMedia, | 922 uploadMedia: _uploadMedia, |
923 downloadOptions: _downloadOptions); | 923 downloadOptions: _downloadOptions); |
(...skipping 178 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1102 * Request parameters: | 1102 * Request parameters: |
1103 * | 1103 * |
1104 * [courseId] - Identifier of the course. | 1104 * [courseId] - Identifier of the course. |
1105 * This identifier can be either the Classroom-assigned identifier or an | 1105 * This identifier can be either the Classroom-assigned identifier or an |
1106 * alias. | 1106 * alias. |
1107 * | 1107 * |
1108 * [courseWorkId] - Identifer of the student work to request. | 1108 * [courseWorkId] - Identifer of the student work to request. |
1109 * This may be set to the string literal `"-"` to request student work for | 1109 * This may be set to the string literal `"-"` to request student work for |
1110 * all course work in the specified course. | 1110 * all course work in the specified course. |
1111 * | 1111 * |
| 1112 * [late] - Requested lateness value. If specified, returned student |
| 1113 * submissions are |
| 1114 * restricted by the requested value. |
| 1115 * If unspecified, submissions are returned regardless of `late` value. |
| 1116 * Possible string values are: |
| 1117 * - "LATE_VALUES_UNSPECIFIED" : A LATE_VALUES_UNSPECIFIED. |
| 1118 * - "LATE_ONLY" : A LATE_ONLY. |
| 1119 * - "NOT_LATE_ONLY" : A NOT_LATE_ONLY. |
| 1120 * |
1112 * [pageToken] - nextPageToken | 1121 * [pageToken] - nextPageToken |
1113 * value returned from a previous | 1122 * value returned from a previous |
1114 * list call, | 1123 * list call, |
1115 * indicating that the subsequent page of results should be returned. | 1124 * indicating that the subsequent page of results should be returned. |
1116 * | 1125 * |
1117 * The list request | 1126 * The list request |
1118 * must be otherwise identical to the one that resulted in this token. | 1127 * must be otherwise identical to the one that resulted in this token. |
1119 * | 1128 * |
| 1129 * [states] - Requested submission states. If specified, returned student |
| 1130 * submissions |
| 1131 * match one of the specified submission states. |
| 1132 * |
1120 * [pageSize] - Maximum number of items to return. Zero or unspecified | 1133 * [pageSize] - Maximum number of items to return. Zero or unspecified |
1121 * indicates that the | 1134 * indicates that the |
1122 * server may assign a maximum. | 1135 * server may assign a maximum. |
1123 * | 1136 * |
1124 * The server may return fewer than the specified number of results. | 1137 * The server may return fewer than the specified number of results. |
1125 * | 1138 * |
1126 * [states] - Requested submission states. If specified, returned student | |
1127 * submissions | |
1128 * match one of the specified submission states. | |
1129 * | |
1130 * [userId] - Optional argument to restrict returned student work to those | 1139 * [userId] - Optional argument to restrict returned student work to those |
1131 * owned by the | 1140 * owned by the |
1132 * student with the specified identifier. The identifier can be one of the | 1141 * student with the specified identifier. The identifier can be one of the |
1133 * following: | 1142 * following: |
1134 * | 1143 * |
1135 * * the numeric identifier for the user | 1144 * * the numeric identifier for the user |
1136 * * the email address of the user | 1145 * * the email address of the user |
1137 * * the string literal `"me"`, indicating the requesting user | 1146 * * the string literal `"me"`, indicating the requesting user |
1138 * | 1147 * |
1139 * [late] - Requested lateness value. If specified, returned student | |
1140 * submissions are | |
1141 * restricted by the requested value. | |
1142 * If unspecified, submissions are returned regardless of `late` value. | |
1143 * Possible string values are: | |
1144 * - "LATE_VALUES_UNSPECIFIED" : A LATE_VALUES_UNSPECIFIED. | |
1145 * - "LATE_ONLY" : A LATE_ONLY. | |
1146 * - "NOT_LATE_ONLY" : A NOT_LATE_ONLY. | |
1147 * | |
1148 * Completes with a [ListStudentSubmissionsResponse]. | 1148 * Completes with a [ListStudentSubmissionsResponse]. |
1149 * | 1149 * |
1150 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 1150 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
1151 * error. | 1151 * error. |
1152 * | 1152 * |
1153 * If the used [http.Client] completes with an error when making a REST call, | 1153 * If the used [http.Client] completes with an error when making a REST call, |
1154 * this method will complete with the same error. | 1154 * this method will complete with the same error. |
1155 */ | 1155 */ |
1156 async.Future<ListStudentSubmissionsResponse> list(core.String courseId, core.S
tring courseWorkId, {core.String pageToken, core.int pageSize, core.List<core.St
ring> states, core.String userId, core.String late}) { | 1156 async.Future<ListStudentSubmissionsResponse> list(core.String courseId, core.S
tring courseWorkId, {core.String late, core.String pageToken, core.List<core.Str
ing> states, core.int pageSize, core.String userId}) { |
1157 var _url = null; | 1157 var _url = null; |
1158 var _queryParams = new core.Map(); | 1158 var _queryParams = new core.Map(); |
1159 var _uploadMedia = null; | 1159 var _uploadMedia = null; |
1160 var _uploadOptions = null; | 1160 var _uploadOptions = null; |
1161 var _downloadOptions = commons.DownloadOptions.Metadata; | 1161 var _downloadOptions = commons.DownloadOptions.Metadata; |
1162 var _body = null; | 1162 var _body = null; |
1163 | 1163 |
1164 if (courseId == null) { | 1164 if (courseId == null) { |
1165 throw new core.ArgumentError("Parameter courseId is required."); | 1165 throw new core.ArgumentError("Parameter courseId is required."); |
1166 } | 1166 } |
1167 if (courseWorkId == null) { | 1167 if (courseWorkId == null) { |
1168 throw new core.ArgumentError("Parameter courseWorkId is required."); | 1168 throw new core.ArgumentError("Parameter courseWorkId is required."); |
1169 } | 1169 } |
| 1170 if (late != null) { |
| 1171 _queryParams["late"] = [late]; |
| 1172 } |
1170 if (pageToken != null) { | 1173 if (pageToken != null) { |
1171 _queryParams["pageToken"] = [pageToken]; | 1174 _queryParams["pageToken"] = [pageToken]; |
1172 } | 1175 } |
| 1176 if (states != null) { |
| 1177 _queryParams["states"] = states; |
| 1178 } |
1173 if (pageSize != null) { | 1179 if (pageSize != null) { |
1174 _queryParams["pageSize"] = ["${pageSize}"]; | 1180 _queryParams["pageSize"] = ["${pageSize}"]; |
1175 } | 1181 } |
1176 if (states != null) { | |
1177 _queryParams["states"] = states; | |
1178 } | |
1179 if (userId != null) { | 1182 if (userId != null) { |
1180 _queryParams["userId"] = [userId]; | 1183 _queryParams["userId"] = [userId]; |
1181 } | 1184 } |
1182 if (late != null) { | |
1183 _queryParams["late"] = [late]; | |
1184 } | |
1185 | 1185 |
1186 _url = 'v1/courses/' + commons.Escaper.ecapeVariable('$courseId') + '/course
Work/' + commons.Escaper.ecapeVariable('$courseWorkId') + '/studentSubmissions'; | 1186 _url = 'v1/courses/' + commons.Escaper.ecapeVariable('$courseId') + '/course
Work/' + commons.Escaper.ecapeVariable('$courseWorkId') + '/studentSubmissions'; |
1187 | 1187 |
1188 var _response = _requester.request(_url, | 1188 var _response = _requester.request(_url, |
1189 "GET", | 1189 "GET", |
1190 body: _body, | 1190 body: _body, |
1191 queryParams: _queryParams, | 1191 queryParams: _queryParams, |
1192 uploadOptions: _uploadOptions, | 1192 uploadOptions: _uploadOptions, |
1193 uploadMedia: _uploadMedia, | 1193 uploadMedia: _uploadMedia, |
1194 downloadOptions: _downloadOptions); | 1194 downloadOptions: _downloadOptions); |
(...skipping 588 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1783 * | 1783 * |
1784 * * `NOT_FOUND` if the course does not exist. | 1784 * * `NOT_FOUND` if the course does not exist. |
1785 * * `PERMISSION_DENIED` for access errors. | 1785 * * `PERMISSION_DENIED` for access errors. |
1786 * | 1786 * |
1787 * Request parameters: | 1787 * Request parameters: |
1788 * | 1788 * |
1789 * [courseId] - Identifier of the course. | 1789 * [courseId] - Identifier of the course. |
1790 * This identifier can be either the Classroom-assigned identifier or an | 1790 * This identifier can be either the Classroom-assigned identifier or an |
1791 * alias. | 1791 * alias. |
1792 * | 1792 * |
| 1793 * [pageSize] - Maximum number of items to return. Zero means no maximum. |
| 1794 * |
| 1795 * The server may return fewer than the specified number of results. |
| 1796 * |
1793 * [pageToken] - nextPageToken | 1797 * [pageToken] - nextPageToken |
1794 * value returned from a previous | 1798 * value returned from a previous |
1795 * list call, indicating that | 1799 * list call, indicating that |
1796 * the subsequent page of results should be returned. | 1800 * the subsequent page of results should be returned. |
1797 * | 1801 * |
1798 * The list request must be | 1802 * The list request must be |
1799 * otherwise identical to the one that resulted in this token. | 1803 * otherwise identical to the one that resulted in this token. |
1800 * | 1804 * |
1801 * [pageSize] - Maximum number of items to return. Zero means no maximum. | |
1802 * | |
1803 * The server may return fewer than the specified number of results. | |
1804 * | |
1805 * Completes with a [ListStudentsResponse]. | 1805 * Completes with a [ListStudentsResponse]. |
1806 * | 1806 * |
1807 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 1807 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
1808 * error. | 1808 * error. |
1809 * | 1809 * |
1810 * If the used [http.Client] completes with an error when making a REST call, | 1810 * If the used [http.Client] completes with an error when making a REST call, |
1811 * this method will complete with the same error. | 1811 * this method will complete with the same error. |
1812 */ | 1812 */ |
1813 async.Future<ListStudentsResponse> list(core.String courseId, {core.String pag
eToken, core.int pageSize}) { | 1813 async.Future<ListStudentsResponse> list(core.String courseId, {core.int pageSi
ze, core.String pageToken}) { |
1814 var _url = null; | 1814 var _url = null; |
1815 var _queryParams = new core.Map(); | 1815 var _queryParams = new core.Map(); |
1816 var _uploadMedia = null; | 1816 var _uploadMedia = null; |
1817 var _uploadOptions = null; | 1817 var _uploadOptions = null; |
1818 var _downloadOptions = commons.DownloadOptions.Metadata; | 1818 var _downloadOptions = commons.DownloadOptions.Metadata; |
1819 var _body = null; | 1819 var _body = null; |
1820 | 1820 |
1821 if (courseId == null) { | 1821 if (courseId == null) { |
1822 throw new core.ArgumentError("Parameter courseId is required."); | 1822 throw new core.ArgumentError("Parameter courseId is required."); |
1823 } | 1823 } |
| 1824 if (pageSize != null) { |
| 1825 _queryParams["pageSize"] = ["${pageSize}"]; |
| 1826 } |
1824 if (pageToken != null) { | 1827 if (pageToken != null) { |
1825 _queryParams["pageToken"] = [pageToken]; | 1828 _queryParams["pageToken"] = [pageToken]; |
1826 } | 1829 } |
1827 if (pageSize != null) { | |
1828 _queryParams["pageSize"] = ["${pageSize}"]; | |
1829 } | |
1830 | 1830 |
1831 _url = 'v1/courses/' + commons.Escaper.ecapeVariable('$courseId') + '/studen
ts'; | 1831 _url = 'v1/courses/' + commons.Escaper.ecapeVariable('$courseId') + '/studen
ts'; |
1832 | 1832 |
1833 var _response = _requester.request(_url, | 1833 var _response = _requester.request(_url, |
1834 "GET", | 1834 "GET", |
1835 body: _body, | 1835 body: _body, |
1836 queryParams: _queryParams, | 1836 queryParams: _queryParams, |
1837 uploadOptions: _uploadOptions, | 1837 uploadOptions: _uploadOptions, |
1838 uploadMedia: _uploadMedia, | 1838 uploadMedia: _uploadMedia, |
1839 downloadOptions: _downloadOptions); | 1839 downloadOptions: _downloadOptions); |
(...skipping 1146 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2986 } | 2986 } |
2987 | 2987 |
2988 } | 2988 } |
2989 | 2989 |
2990 | 2990 |
2991 | 2991 |
2992 /** Additional details for assignments. */ | 2992 /** Additional details for assignments. */ |
2993 class Assignment { | 2993 class Assignment { |
2994 /** | 2994 /** |
2995 * Drive folder where attachments from student submissions are placed. | 2995 * Drive folder where attachments from student submissions are placed. |
2996 * This is only populated for course teachers. | 2996 * This is only populated for course teachers and administrators. |
2997 */ | 2997 */ |
2998 DriveFolder studentWorkFolder; | 2998 DriveFolder studentWorkFolder; |
2999 | 2999 |
3000 Assignment(); | 3000 Assignment(); |
3001 | 3001 |
3002 Assignment.fromJson(core.Map _json) { | 3002 Assignment.fromJson(core.Map _json) { |
3003 if (_json.containsKey("studentWorkFolder")) { | 3003 if (_json.containsKey("studentWorkFolder")) { |
3004 studentWorkFolder = new DriveFolder.fromJson(_json["studentWorkFolder"]); | 3004 studentWorkFolder = new DriveFolder.fromJson(_json["studentWorkFolder"]); |
3005 } | 3005 } |
3006 } | 3006 } |
(...skipping 2391 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
5398 } | 5398 } |
5399 if (thumbnailUrl != null) { | 5399 if (thumbnailUrl != null) { |
5400 _json["thumbnailUrl"] = thumbnailUrl; | 5400 _json["thumbnailUrl"] = thumbnailUrl; |
5401 } | 5401 } |
5402 if (title != null) { | 5402 if (title != null) { |
5403 _json["title"] = title; | 5403 _json["title"] = title; |
5404 } | 5404 } |
5405 return _json; | 5405 return _json; |
5406 } | 5406 } |
5407 } | 5407 } |
OLD | NEW |