- Import cloud function package
import 'package:cloud_functions/cloud_functions.dart';- Create a function callable
final HttpsCallable callable = CloudFunctions.instance
.getHttpsCallable(functionName: 'helloWorld')
..timeout = const Duration(seconds: 30);This will create an object that can be called later, the function name is the name of the function in firebase. Additionally make sure to add a timeout on the callable.
- When needed (ex:
onPressedcall) call the the callable
onPressed: () async {
try {
final HttpsCallableResult result = await callable.call();
print(result.data);
} on CloudFunctionsException catch (e) {
print('caught firebase functions exception');
print(e.code);
print(e.message);
print(e.details);
} catch (e) {
print('caught generic exception');
print(e);
}
}In this example the onPressed call will call an async function that, in a try/catch, will call the previously made callable and save the returned data in a HttpsCallableResult object. Getting the data from the HttpsCallableResult object depends on the returned data but a simple result.data will work for most cases
API for working with data on the Cloud Firestore, particularly for linking data between the Google Classroom API and the Firestore.
1. void doTransaction(String onSuccess, String onError, Function transaction) async
Wrapper that performs a Firestore Transaction in a synchronized manner. Called during reads and writes to the Firestore to ensure atomicity of reads and writes.
onSuccess: message displayed upon the operation's successonError: message displayed if the operation does not succeedtransaction: operation to be performed during a transcation. This should be a read or write operation to the Firestore. ...
2. void setUserData(FirebaseUser user, {toMerge: true}) async
Updates the per-user document in the 'users' collection with current user information, if the information exists. Otherwise, creates an entry in the document to contain the information. Called once on user sign in by default.
user: object storing the currently logged in FireBase user from which appropriate information is extracted.toMerge: optional flag that decides whether this data will be merged with the current data on Firebase (if true) or overwrite it (if false). Set to true by default if no value is specified.
3. void setClassroomData(FirebaseUser user, {toMerge: true}) async
Updates the per-user document in the 'users' collection with current information about courses that they are subscribed to, if the information exists. Otherwise, creates an entry in the document to contain the information. Called once on user sign in by default.
user: object storing the currently logged in FireBase user from which appropriate information is extracted.toMerge: optional flag that decides whether this data will be merged with the current data on Firebase (if true) or overwrite it (if false). Set to true by default if no value is specified.
4. void setUserCourseWorkData(FirebaseUser user, String courseId, {toMerge: true}) async
Updates the per-user document in the 'users' collection with current information about course work that they are allowed to view from classes that they are subscribed to, if the information exists. Otherwise, creates an entry in the document to contain the information. Called once on user sign in by default.
user: object storing the currently logged in FireBase user from which appropriate information is extracted.courseId: id of course for which to pull course works for from classroom.toMerge: optional flag that decides whether this data will be merged with the current data on Firebase (if true) or overwrite it (if false). Set to true by default if no value is specified.
5. void setUserAnnouncementData(FirebaseUser user, String courseId, {toMerge: true}) async
Updates the per-user document in the 'users' collection with current information about course announcements that they are allowed to view from classes that they are subscribed to, if the information exists. Otherwise, creates an entry in the document to contain the information. Called once on user sign in by default.
user: object storing the currently logged in FireBase user from which appropriate information is extracted.courseId: id of course for which to pull course announcements for from classroom.toMerge: optional flag that decides whether this data will be merged with the current data on Firebase (if true) or overwrite it (if false). Set to true by default if no value is specified.
5. void setUserClassStudents(FirebaseUser user, String courseId, {toMerge: true}) async
Updates the per-user document in the 'users' collection with current information about students in the current user's subscribed classes, if the information exists. Otherwise, creates an entry in the document to contain the information. Called once on user sign in by default.
user: object storing the currently logged in FireBase user from which appropriate information is extracted.courseId: id of course for which to pull course students for from classroom.toMerge: optional flag that decides whether this data will be merged with the current data on Firebase (if true) or overwrite it (if false). Set to true by default if no value is specified.
6. void setUserClassTeachers(FirebaseUser user,String courseId, {toMerge: true}) async
Updates the per-user document in the 'users' collection with current information about teachers of the current user's subscribed classes, if the information exists. Otherwise, creates an entry in the document to contain the information. Called once on user sign in by default.
user: object storing the currently logged in FireBase user from which appropriate information is extracted.courseId: id of course for which to pull course teachers for from classroom.toMerge: optional flag that decides whether this data will be merged with the current data on Firebase (if true) or overwrite it (if false). Set to true by default if no value is specified.
7. void setUserClassTopics(FirebaseUser user, String courseTopics, {toMerge: true}) async
Updates the per-user document in the 'users' collection with current information about course topics from the current user's subscribed classes, if the information exists. Otherwise, creates an entry in the document to contain the information. Called once on user sign in by default.
user: object storing the currently logged in FireBase user from which appropriate information is extracted.courseId: id of course for which to pull course topics for from classroom.toMerge: optional flag that decides whether this data will be merged with the current data on Firebase (if true) or overwrite it (if false). Set to true by default if no value is specified.
8. Future<List<classroom.Course>> pullCourses(FirebaseUser user) async
Pulls information about courses that the current user is subscribed to from the Firestore.
user: object storing the currently logged in FireBase user from which appropriate information is extracted.
A Future of List<classroom.Course> where the list value of the future contains the classroom.Course objects that define each of the user's courses. The return of this function cannot be used directly and must be processed as in the example code.
class DashboardScreenState extends State<DashboardScreen> {
List<classroom.Course> _courses = new List<classroom.Course>();
Future<void> processFuture() async {
List<classroom.Course> tempCourses = await pullCourses(firebaseUser);
setState(() {
_courses = tempCourses;
});
}
@override
void initState() {
super.initState();
processFuture().then((arg) {
// ANY CODE THAT DEPENDS ON processFuture() COMPLETING FIRST
}, onError: (e) {
print(e);
// ERROR HANDLING CODE
});
// ANY CODE THAT DOES NOT DEPEND ON processFuture() TO COMPLETE
}
}Because this method is asynchronous, it will return a Future<T> which must be processed by the user to extract the T object of the Future. The 'await' keyword allows to wait for a Future to complete its task. Once the task is completed, the returned object is extracted from the Future and can be used regularly. The reason for using setState() instead of a direct assignment to _courses is that without calling setState() there is no guarantee that the state variable _courses is updated at the appropriate time. Not following this example may introduce race conditions into your code where the build() method of your widget is executed before the data is ready resulting in no guarantees on the completeness of data being returned.
9. Future<List<classroom.CourseWork>> pullCourseWorkData(FirebaseUser user) async
Pulls information about course work objects for the courses that the current user is subscribed to from the Firestore.
user: object storing the currently logged in FireBase user from which appropriate information is extracted.
A Future of List<classroom.CourseWork> where the list value of the future contains the classroom.CourseWork objects that define user course work. The return of this function cannot be used directly and must be processed to extract it from the Future by awaiting its completion.
10. Future<List<classroom.Announcement>> pullCourseAnnouncements(FirebaseUser user) async
Pulls information about announcements that the user is allowed to see for the courses that the current user is subscribed to from the Firestore.
user: object storing the currently logged in FireBase user from which appropriate information is extracted.
A Future of List<classroom.Announcement> where the list value of the future contains the classroom.Announcement objects that define announcements in courses that the user is subscribed to. The return of this function cannot be used directly and must be processed to extract it from the Future by awaiting its completion.
11. Future<List<classroom.Student>> pullClassmates(FirebaseUser user) async
Pulls information about students for the courses that the current user is subscribed to from the Firestore.
user: object storing the currently logged in FireBase user from which appropriate information is extracted.
A Future of List<classroom.Student> where the list value of the future contains the classroom.Student objects that define students in classes that the user is subscribed to. The return of this function cannot be used directly and must be processed to extract it from the Future by awaiting its completion.
12. Future<List<classroom.Teacher>> pullTeachers(FirebaseUser user) async
Pulls information about teachers of the courses that the current user is subscribed to from the Firestore.
user: object storing the currently logged in FireBase user from which appropriate information is extracted.
A Future of List<classroom.Teacher> where the list value of the future contains the classroom.Teacher objects that define teachers for classes that the user is subscribed to. The return of this function cannot be used directly and must be processed to extract it from the Future by awaiting its completion.
13. Future<List<classroom.Topic>> pullTopics(FirebaseUser user) async
Pulls information about course material topics for the courses that the current user is subscribed to from the Firestore.
user: object storing the currently logged in FireBase user from which appropriate information is extracted.
A Future of List<classroom.Topic> where the list value of the future contains the classroom.Topic objects that define each of the user's course topics. The return of this function cannot be used directly and must be processed to extract it from the Future by awaiting its completion.
14. void setUserCourseGoals(FirebaseUser user, List<Goal> courseGoals, String goalType, {toMerge: true}) async
Updates per user goals on Firebase with goals from courseGoals in the goalType section of the document. This method will remove every goal with the specified goal type and replace it with the list of goals inputted as the argument. If you want to keep the current goals, then add the goals from pullGoals to the courseGoals.
user: object storing the currently logged in FireBase user from which appropriate information is extracted.goalType: specifies which section of the Firebase document to push the goals to. One of "CourseGoalObjects" (main goals for a specific course), "GeneralGoalObjects" (general goals for no particular course) or "CourseWorkGoalObjects" (specific goals for an assignment of some course).toMerge: optional flag that decides whether this data will be merged with the current data on Firebase (if true) or overwrite it (if false). Set to true by default if no value is specified.
15. Future<List<Goal>> pullGoals(FirebaseUser user, String goalType) async
Pulls information about goals of a given goalType for this user.
user: object storing the currently logged in FireBase user from which appropriate information is extracted.goalType: specifies which section of the Firebase document to pull goals from. One of "CourseGoalObjects" (main goals for a specific course), "GeneralGoalObjects" (general goals for no particular course) or "CourseWorkGoalObjects" (specific goals for an assignment of some course).
A Future of List<Goal> where the list value of the future contains the Goal objects that define each of the user's goals. The return of this function cannot be used directly and must be processed to extract it from the Future by awaiting its completion.
API for processing data obtained from the Cloud Firestore. This API deals a lot with data types defined in Google's Classroom API, it is suggested to review its documentation as needed to see what fields and methods the returned objects contain.
1. List<classroom.Student> getClassRoster(String courseID, List<classroom.Student> students)
Find and return all students from students who are subscribed to the class with a courseId that matches courseID.
Assumes that students is not null, throws NullArgumentException otherwise.
courseID: course id of the course the students of which are being searched for.students: student objects to search in
A List of all Student objects in students that had a courseId that matched courseID.
2. List<classroom.Teacher> getCourseTeachers(String courseID, List<classroom.Teacher> teachers)
Find and return all teachers in teachers who teach the course with courseId courseID.
Assumes that teachers is not null, throws NullArgumentException otherwise.
courseID: course id of the course the teachers of which are being searched for.teachers: teacher objects to search in
A List of all Teacher objects in topics that had a courseId that matched courseID.
3. List<classroom.Topic> getCourseTopics(String courseID, List<classroom.Topic> topics)
Find and return all course topics in topics for the course with courseId courseID.
Assumes that topics is not null, throws NullArgumentException otherwise.
courseID: course id of the course the topics of which are being searched for.topics: topic objects to search in
A List of all Topic objects in topics that had a courseId that matched courseID.
4. List<classroom.Announcement> getCourseAnnouncements(String courseID, List<classroom.Announcement> announcements)
Find and return all course announcements in announcements for the course with courseId courseID.
Assumes that announcements is not null, throws NullArgumentException otherwise.
courseID: course id of the course the topics of which are being searched for.announcements: announcement objects to search in
A List of all Announcement objects in announcements that had a courseId that matched courseID.
5. List<classroom.CourseWork> getCourseWorksForCourse(String courseID, List<classroom.CourseWork> works)
Find and return all course works in works for the course with courseId courseID.
Assumes that works is not null, throws NullArgumentException otherwise.
courseID: course id of the course the topics of which are being searched for.works: announcement objects to search in
A List of all CourseWork objects in works that had a courseId that matched courseID.
The internal class representation of a student goal within our app. Should be associated with a particular course and a particular cousre work.
String name: name of this goalString text: description of this goalDateTime dueDate: due date of this goal. The raw format of this object is "yyyy-mm-ddThh:mm:ss:nnnn" and so special getter methods should be used to access the full date. Access directly to this object is provided as a convenience in case a specific attribute (such as the month) is needed.String _status: status indicating that the goal is in one of these states: "IN_PROGRESS", "COMPLETED", "COMPLETED_LATE" and "IN_PROGRESS_LATE"String _courseID: ID of Course object that this goal belongs toString _courseWorkID: ID of the CourseWork object that this goal is associated with.
1.
Goal({String name: "BlankGoal", String text: "", courseID: "-1", courseWorkID: "-1", String dueDate: ""})
Every parameter is optional and will be assigned its default value unless otherwise specified. The format for the date string is: "yyyy-mm-ddThh:mm:ss", where T let's the object separate the date from the time during the parsing of the string.
2.
Goal.fromJson(Map<dynamic, dynamic> json)
Create a new Goal object from its JSON representation.
json: JSON representation of this object stored in a Map
A Goal object the fields of which are the keys of the map and their values the corresponding key values from the map.
1. String getStatus()
Get the current status of this goal. Before returning, this method will change the status from on time to late if the goal is in progress and it is currently past the due date.
One of: ("IN_PROGRESS", "COMPLETED", "COMPLETED_LATE", "IN_PROGRESS_LATE").
2. void completeGoal()
Set the state of this goal to one of ("COMPLETED", "COMPLETED_LATE").
3. String getDueTime()
Get the string representation of this goal's due time on a 24-hour clock.
String in the format "hh:mm:ss".
4. String getCalendarDueDate()
Get the string representation of this goal's due date. See Util Doc
String in the format "dd/mm/yyyy".
5. String getCourseId()
Get the ID of the course that this goal is associated with.
A numeric course ID as a string.
6. String getCourseWorkId()
Get the ID of the course work that this goal is associated with.
A numeric course work ID as a string.
7. String toString()
Get the String summary of the object.
This object as a description string.
8. Map<String, dynamic> toJson()
Converts this object into a Json serializable representation using a hash map. For example, the name of the Goal object that was converted can be accessed from the returned Map as follows: returnedMap["name"].
Map object with keys being the fields of the Goal object and the values their corresponding values.
1. String getMonthFromDateStr(String dateString)
Extract and convert the numerical month in a date string to its text representation. For example, for the input "15/11/2019" the return would be "November".
dateString: the string representation of the date the month of which is to be extracted
Assumes that the string is properly formatted as specified. Throws a FormatException otherwise when the string cannot be parsed.
Text representation of the month within the given date.
2. String getMonthFromDateObj(DateTime date)
Extract the month from a date object and return its text representation.
date: a date object from which to extract the month
Text representation of the month within the given date.
3. printError(String header, String error, String stackTrace, {String extraInfo = ""})
Print a nicely formatted custom error message to the debug console using the header to label the message, error as the message text and stackTrace for the location of the error. extraInfo is used to provide optional details about the error.
header: error message header.error: error text. Should be e.toString() where e is the error object caught inside the try-catch block.stackTrace: stack trace of the error. You should use stackTrace.toString() for this argument where stackTrace is the stack trace caught in a try-catch block.extraInfo: optional argument for holding any extra information the developer may want to specify about the error.
try{
//YOUR CODE
} catch (e, stackTrace){
printError("ERROR!", e.toString(), stackTrace.toString(), "Optional Info");
}
"""
Example Output:
-------------------------------------ERROR!-------------------------------------
NoSuchMethodError: The getter 'keys' was called on null.
Receiver: null
Tried calling: keys
Optional Info
Stack Trace:
#0 Object.noSuchMethod (dart:core-patch/object_patch.dart:51:5)
#1 setUserClassTopics (package:student_agenda/FirestoreManager.dart:297:22)
"""4. String getCalendarDueDate(DateTime date)
Get the string representation of date.
date: object from which to extract the date string.
String in the format "dd/mm/yyyy".