Documentation
¶
Overview ¶
change-password
check-permission
delete-account
error-types
file-download
forum-create-message
forum-create-topic
forum-messages
forum
lesson-description
logout
mail-address-book
mail-delete-letter
mail-description
mail-send-letter
mark-unmark-done
posts
push-delete
push-do-not-disturb
push-settings
report-average-dyn
report-average-mark
report-grades-lessons
report-journal-access
report-parent-letter-data
report-parent-letter
report-student-total
report-total-marks
resources
Package restapi содержит handler'ы для взаимодействия сервера с клиентами.
schedule
school-list
sign-in
tasks-and-marks
Index ¶
- func NewMarshalledErrors(logger *log.Logger) *marshalledErrors
- type File
- type Post
- type RestAPI
- func (rest *RestAPI) BindHandlers() http.Handler
- func (rest *RestAPI) ChangePasswordHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) CheckPermissionHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) CreateTopicHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) CreateTopicMessageHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) DeleteAccountHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) DeleteMailHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) ErrorHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) FileHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) GetAddressBookHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) GetForumHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) GetForumMessagesHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) GetLessonDescriptionHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) GetMailDescriptionHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) GetMailHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) GetPostsHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) GetReportJournalAccessHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) GetReportParentInfoLetterDataHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) GetReportParentInfoLetterHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) GetReportStudentAverageMarkDynHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) GetReportStudentAverageMarkHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) GetReportStudentGradesHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) GetReportStudentGradesLessonListHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) GetReportStudentTotalHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) GetReportStudentTotalMarksHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) GetResourcesHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) GetScheduleHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) GetSchoolListHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) GetTasksAndMarksHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) Handler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) LogOutHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) MarkAsDoneHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) PushDontDisturbHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) PushSettingsHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) SendLetterHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) SignInHandler(respwr http.ResponseWriter, req *http.Request)
- func (rest *RestAPI) UnmarkAsDoneHandler(respwr http.ResponseWriter, req *http.Request)
- type SchoolListResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewMarshalledErrors ¶
Types ¶
type Post ¶
type Post struct {
Unread bool `json:"unread"`
Author string `json:"author"`
Title string `json:"title"`
Date string `json:"date"`
Message string `json:"message"`
Files []File `json:"files"`
}
type Post struct используется в postsResponse
type RestAPI ¶
type RestAPI struct {
Store *redistore.RediStore
Db *db.Database
Redis *red.Database
Errors *marshalledErrors
Push *push.Push
// contains filtered or unexported fields
}
RestAPI struct содержит конфигурацию Rest API. sessionsMap содержит отображения идентификаторов сессий Rest API в объекты сессий на удаленном сервере.
func NewRestAPI ¶
func NewRestAPI(logger *log.Logger, config *cp.Config, database *db.Database, p *push.Push) *RestAPI
NewRestAPI создает структуру для работы с Rest API.
func (*RestAPI) BindHandlers ¶
BindHandlers привязывает все handler'ы Rest API
func (*RestAPI) ChangePasswordHandler ¶
func (rest *RestAPI) ChangePasswordHandler(respwr http.ResponseWriter, req *http.Request)
ChangePasswordHandler обрабатывает запросы на удаление письма
func (*RestAPI) CheckPermissionHandler ¶
func (rest *RestAPI) CheckPermissionHandler(respwr http.ResponseWriter, req *http.Request)
CheckPermissionHandler проверяет, есть ли разрешение на работу с школой
func (*RestAPI) CreateTopicHandler ¶
func (rest *RestAPI) CreateTopicHandler(respwr http.ResponseWriter, req *http.Request)
CreateTopicHandler обрабатывает запросы на получение тем форума
func (*RestAPI) CreateTopicMessageHandler ¶
func (rest *RestAPI) CreateTopicMessageHandler(respwr http.ResponseWriter, req *http.Request)
CreateTopicMessageHandler обрабатывает запросы на получение тем форума
func (*RestAPI) DeleteAccountHandler ¶
func (rest *RestAPI) DeleteAccountHandler(respwr http.ResponseWriter, req *http.Request)
DeleteAccountHandler обрабатывает запрос на псевдоудаление аккаунта
func (*RestAPI) DeleteMailHandler ¶
func (rest *RestAPI) DeleteMailHandler(respwr http.ResponseWriter, req *http.Request)
DeleteMailHandler обрабатывает запросы на удаление письма
func (*RestAPI) ErrorHandler ¶
func (rest *RestAPI) ErrorHandler(respwr http.ResponseWriter, req *http.Request)
ErrorHandler обрабатывает некорректные запросы.
func (*RestAPI) FileHandler ¶
func (rest *RestAPI) FileHandler(respwr http.ResponseWriter, req *http.Request)
FileHandler обрабатывает запросы на получение файлов
func (*RestAPI) GetAddressBookHandler ¶
func (rest *RestAPI) GetAddressBookHandler(respwr http.ResponseWriter, req *http.Request)
GetAddressBookHandler обрабатывает запросы на получение списка адресатов
func (*RestAPI) GetForumHandler ¶
func (rest *RestAPI) GetForumHandler(respwr http.ResponseWriter, req *http.Request)
GetForumHandler обрабатывает запросы на получение тем форума
func (*RestAPI) GetForumMessagesHandler ¶
func (rest *RestAPI) GetForumMessagesHandler(respwr http.ResponseWriter, req *http.Request)
GetForumMessagesHandler обрабатывает запросы на получение тем форума
func (*RestAPI) GetLessonDescriptionHandler ¶
func (rest *RestAPI) GetLessonDescriptionHandler(respwr http.ResponseWriter, req *http.Request)
GetLessonDescriptionHandler обрабатывает запрос на получение подробностей дз
func (*RestAPI) GetMailDescriptionHandler ¶
func (rest *RestAPI) GetMailDescriptionHandler(respwr http.ResponseWriter, req *http.Request)
GetMailDescriptionHandler обрабатывает запросы на получение подробностей письма
func (*RestAPI) GetMailHandler ¶
func (rest *RestAPI) GetMailHandler(respwr http.ResponseWriter, req *http.Request)
GetMailHandler обрабатывает запросы на получение списка писем
func (*RestAPI) GetPostsHandler ¶
func (rest *RestAPI) GetPostsHandler(respwr http.ResponseWriter, req *http.Request)
GetPostsHandler обрабатывает запрос на получение объявлений
func (*RestAPI) GetReportJournalAccessHandler ¶
func (rest *RestAPI) GetReportJournalAccessHandler(respwr http.ResponseWriter, req *http.Request)
GetReportJournalAccessHandler обрабатывает запрос на получение отчета о доступе к классному журналу
func (*RestAPI) GetReportParentInfoLetterDataHandler ¶
func (rest *RestAPI) GetReportParentInfoLetterDataHandler(respwr http.ResponseWriter, req *http.Request)
GetReportParentInfoLetterDataHandler обрабатывает запрос на получение шаблона письма родителям
func (*RestAPI) GetReportParentInfoLetterHandler ¶
func (rest *RestAPI) GetReportParentInfoLetterHandler(respwr http.ResponseWriter, req *http.Request)
GetReportParentInfoLetterHandler обрабатывает запрос на получение шаблона письма родителям
func (*RestAPI) GetReportStudentAverageMarkDynHandler ¶
func (rest *RestAPI) GetReportStudentAverageMarkDynHandler(respwr http.ResponseWriter, req *http.Request)
GetReportStudentAverageMarkDynHandler обрабатывает запрос на получение отчета о динамике среднего балла
func (*RestAPI) GetReportStudentAverageMarkHandler ¶
func (rest *RestAPI) GetReportStudentAverageMarkHandler(respwr http.ResponseWriter, req *http.Request)
GetReportStudentAverageMarkHandler обрабатывает запрос на получение отчета о среднем балле
func (*RestAPI) GetReportStudentGradesHandler ¶
func (rest *RestAPI) GetReportStudentGradesHandler(respwr http.ResponseWriter, req *http.Request)
GetReportStudentGradesHandler обрабатывает запрос на получение отчета 'Об успеваемости'
func (*RestAPI) GetReportStudentGradesLessonListHandler ¶
func (rest *RestAPI) GetReportStudentGradesLessonListHandler(respwr http.ResponseWriter, req *http.Request)
GetReportStudentGradesLessonListHandler обрабатывает запрос на получение списка предметов для отчета 'Об успеваемости'
func (*RestAPI) GetReportStudentTotalHandler ¶
func (rest *RestAPI) GetReportStudentTotalHandler(respwr http.ResponseWriter, req *http.Request)
GetReportStudentTotalHandler обрабатывает запрос на получение отчета об успеваемости и посещаемости
func (*RestAPI) GetReportStudentTotalMarksHandler ¶
func (rest *RestAPI) GetReportStudentTotalMarksHandler(respwr http.ResponseWriter, req *http.Request)
GetReportStudentTotalMarksHandler обрабатывает запрос на получение отчета об итоговых оценках
func (*RestAPI) GetResourcesHandler ¶
func (rest *RestAPI) GetResourcesHandler(respwr http.ResponseWriter, req *http.Request)
GetResourcesHandler обрабатывает запросы на получение школьных ресурсов
func (*RestAPI) GetScheduleHandler ¶
func (rest *RestAPI) GetScheduleHandler(respwr http.ResponseWriter, req *http.Request)
GetScheduleHandler возвращает расписание на неделю
func (*RestAPI) GetSchoolListHandler ¶
func (rest *RestAPI) GetSchoolListHandler(respwr http.ResponseWriter, req *http.Request)
GetSchoolListHandler обрабатывает запрос на получение списка обслуживаемых школ
func (*RestAPI) GetTasksAndMarksHandler ¶
func (rest *RestAPI) GetTasksAndMarksHandler(respwr http.ResponseWriter, req *http.Request)
GetTasksAndMarksHandler возвращает задания и оценки на неделю
func (*RestAPI) Handler ¶
func (rest *RestAPI) Handler(respwr http.ResponseWriter, req *http.Request)
Handler временный абстрактный handler для некоторых еще не реализованных обработчиков запросов.
func (*RestAPI) LogOutHandler ¶
func (rest *RestAPI) LogOutHandler(respwr http.ResponseWriter, req *http.Request)
LogOutHandler обрабатывает удаление сессии клиента и отвязку устройства
func (*RestAPI) MarkAsDoneHandler ¶
func (rest *RestAPI) MarkAsDoneHandler(respwr http.ResponseWriter, req *http.Request)
MarkAsDoneHandler обрабатывает запрос на отметку задания как сделанного
func (*RestAPI) PushDontDisturbHandler ¶
func (rest *RestAPI) PushDontDisturbHandler(respwr http.ResponseWriter, req *http.Request)
PushDontDisturbHandler обрабатывает запросы на удаление письма
func (*RestAPI) PushSettingsHandler ¶
func (rest *RestAPI) PushSettingsHandler(respwr http.ResponseWriter, req *http.Request)
PushSettingsHandler обрабатывает запрос на отметку задания как сделанного
func (*RestAPI) SendLetterHandler ¶
func (rest *RestAPI) SendLetterHandler(respwr http.ResponseWriter, req *http.Request)
SendLetterHandler обрабатывает запросы на создание письма
func (*RestAPI) SignInHandler ¶
func (rest *RestAPI) SignInHandler(respwr http.ResponseWriter, req *http.Request)
SignInHandler обрабатывает вход в учетную запись на сайте школы
func (*RestAPI) UnmarkAsDoneHandler ¶
func (rest *RestAPI) UnmarkAsDoneHandler(respwr http.ResponseWriter, req *http.Request)
UnmarkAsDoneHandler обрабатывает запрос на отметку задания как просмотренного
type SchoolListResponse ¶
type SchoolListResponse struct {
Schools []school `json:"schools"`
}
SchoolListResponse используется в GetSchoolListHandler
Source Files
¶
- change-password.go
- check-permission.go
- delete-account.go
- error-types.go
- file-download.go
- forum-create-message.go
- forum-create-topic.go
- forum-messages.go
- forum.go
- lesson-description.go
- logout.go
- mail-address-book.go
- mail-delete-letter.go
- mail-description.go
- mail-send-letter.go
- mail.go
- mark-unmark-done.go
- posts.go
- push-delete.go
- push-do-not-disturb.go
- push-settings.go
- report-average-dyn.go
- report-average-mark.go
- report-grades-lessons.go
- report-journal-access.go
- report-parent-letter-data.go
- report-parent-letter.go
- report-student-total.go
- report-total-marks.go
- resources.go
- rest-api.go
- schedule.go
- school-list.go
- sign-in.go
- tasks-and-marks.go