# Functions
DeleteEmailToken deletes the given email token.
GetClassesForUser gets all HomeworkClasses for the given user.
GetDataForSchool returns the data associated with the User's enrollment in the given School.
GetEmailToken fetches the given email token.
GetPrefForUser fetches the Pref with the given key for the given user.
GetPrefixesForUser returns a list of all prefixes for the given user, factoring in schools and custom settings.
GetProvidersForUser returns a list of calendar providers associated with the given user.
GetSchoolsForUser returns a list of schools that the given user is enrolled in, excluding disabled schools.
GetTabsByUserID fetches all tabs that the given user has access to.
GetUserByID fetches data for the given user ID.
SaveEmailToken saves the given email token with a default expiry.
UserExistsWithEmail checks for a user with the given email address.
# Constants
end of a break (exclusive of that day!).
start of a break (inclusive of that day!).
no classes at all.
just informative.
Define the default EmailTokenType.
Define the default EmailTokenType.
Define the default EmailTokenType.
Define the default EmailTokenType.
The available event tags.
The available event tags.
The available event tags.
The available event tags.
The available event tags.
The available event tags.
The available event tags.
The available event tags.
The available event tags.
The available event tags.
The available event tags.
The available event tags.
The available event tags.
The available event tags.
The available event tags.
The available event tags.
The available event tags.
The available event tags.
The available event tags.
The available event tags.
The available event tags.
The available event tags.
The available event tags.
The available event tags.
The available event tags.
The available event tags.
FallbackBackground is the background color of a word that does not have an associated prefix.
FallbackColor is the text color of a word that does not have an associated prefix.
No description provided by the author
No description provided by the author
No description provided by the author
Define the default RecurFrequencies.
Define the default RecurFrequencies.
Define the default RecurFrequencies.
Define the default RecurFrequencies.
# Variables
No description provided by the author
DefaultPrefixes is the list of prefixes that all users start out with.
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
An Application describes a third-party application designed to integrate with MyHomeworkSpace.
An ApplicationAuthorization describes a user's authorization of an application's access to their account.
DetailedSchoolError is a type of Error that occurs when a school provider wants to communicate data back to the client along with an error.
An EmailToken is used for situations like an email change or a password reset, where a confirmation email must be sent.
An Event is an event on a user's calendar.
An EventAction is an action that can be performed on an Event; for example, a link to open a class's website.
An EventChange is a modification a user makes to an Event that came from a provider.
No description provided by the author
No description provided by the author
A HomeworkClass is a class that can be associated with Homework items.
An OffBlock is a period of time that's marked off on a calendar, such as a holiday.
No description provided by the author
No description provided by the author
No description provided by the author
A Prefix defines a group of words that get automatically recognized (for example: HW, Test, Quiz).
A ProviderData struct contains all data returned by a Provider for a given time.
A RecurRule struct contains information about how an event recurs.
SchoolError is a type of Error that occurs due to invalid data or a similar condition.
SchoolInfo is a struct that holds information about a school.
SchoolResult is a struct that holds information about a school that was searched for.
No description provided by the author
No description provided by the author
# Interfaces
A Provider is a source of calendar data (events, announcements, etc).
School is an interface implemented by all schools that a user can connect to their account.
SchoolRegistry is an interface implemented by the central registry in the schools package.
# Type aliases
An EmailTokenType describes different types of email token.
An EventTagType describes the type of an event tag.
ProviderDataType describes the different types of data that can be requested from a Provider.
A RecurFrequency describes how often an event recurs.