Skip to content

guide.md

Latest commit

 

History

History
262 lines (154 loc) · 8.44 KB

guide.md

File metadata and controls

262 lines (154 loc) · 8.44 KB

Методы

Управление сессией

По умолчанию эти методы применяются автоматически. Они доступны при импорте класса Safe.

.logIn()

Не принимает аргументы

Возвращает объект класса Session

Пример использования

.logOut()

Не принимает аргументы

Возвращает void при успешном выходе или ошибку

Пример использования

.sessionValid()

Не принимает аргументы

Возвращает true если сессия активна

Пример использования

Пользователь

.info()

Не принимает аргументы

Возвращает объект класса Info

Пример использования

.photo()

Принимает объект данных:

  • studentId?: number - ID учащегося, можно не указывать.

Возвращает Buffer

Пример использования

Дневник

.diary()

Период дневника может составлять более 7 дней, главное, чтобы он не выходил за рамки учебного года.

Принимает объект данных:

  • studentId?: number - ID учащегося, можно не указывать.
  • start: Date - Дата, с которой начинается дневник
  • end: Date - Последний день в дневнике

Возвращает объект класса Diary

Пример использования

.assignment()

Принимает объект данных:

  • studentId?: number - ID учащегося, можно не указывать.
  • id: number - ID задания

Возвращает объект класса AssignmentInfo

Пример использования

.downloadFile()

Принимает объект данных:

  • studentId?: number - ID учащегося, можно не указывать.
  • assignId: number - ID задания, с которым связан файл
  • id: number - ID файла

Возвращает файл в виде Buffer

Пример использования

.assignmentTypes()

Не принимает аргументы

Возвращает объект класса AssignmentTypes

Пример использования

Расписание

.scheduleDay()

Принимает объект данных:

  • classId?: number - ID класса, можно не указывать
  • date?: Date - Дата дня, на который нужно получить расписание.

Возвращает объект класса ScheduleDay

Пример использования

.scheduleWeek()

Принимает объект данных:

  • classId?: number - ID класса, можно не указывать
  • date?: Date - Дата дня, на который нужно получить расписание.

Возвращает объект класса ScheduleWeek

Пример использования

Отчеты

.reportFile()

Принимает объект данных:

  • url: string - Ссылка на таскер (например для "Отчет об успеваемости и посещаемости ученика" это reports/studenttotal/queue )
  • filters: { filterId: string, filterValue: string }[] - Массив с фильтрами (форма, которая находится на странице запроса)
  • yearId?: number - ID года, за который требуется отчет
  • timeout?: number - Время в миллисекундах, через которое запрос будет закрыт (по умолчания 60000, при значении -1 запрос не будет закрываться)
  • transport?: 0 | 1 - 0 - Web Sockets, 1 - Long Polling (если отсутствует, то используется Web Sockets или Long Polling, в зависимости от версии сервера)

Возвращает html с результатом запроса

Пример использования

.grades()

Принимает объект данных:

  • ​subjectId​: ​number​ - ID предмета
  • start​?: ​Date​ - начало периода
  • end​?: ​Date​ - окончание периода
  • termId​?: ​number​ - ID четверти
  • ​classId​?: ​number​ - ID класса
  • studentId​?: ​number​ - ID учащегося
  • transport?: 0 | 1 - 0 - Web Sockets, 1 - Long Polling (если отсутствует, то используется Web Sockets или Long Polling, в зависимости от версии сервера)

Возвращает объект класса Grades

Пример использования

.journal()

Принимает объект данных:

  • start​?: ​Date​ - начало периода
  • end​?: ​Date​ - окончание периода
  • termId​?: ​number​ - ID четверти
  • ​classId​?: ​number​ - ID класса
  • studentId​?: ​number​ - ID учащегося
  • transport?: 0 | 1 - 0 - Web Sockets, 1 - Long Polling (если отсутствует, то используется Web Sockets или Long Polling, в зависимости от версии сервера)

Возвращает объект класса Journal

Пример использования

Дополнительно

.fetch()

Принимает данные:

  • url: string - Ссылка на ресурс
  • init?: InitRequest - Объект InitRequest

Возвращает объект класса Response

Пример использования

.getProxy()

Не принимает аргументы

Возвращает объект класса HttpsProxyAgent

.setProxy()

Принимает аргументы:

  • url: string - Ссылка на прокси сервер

Возвращает объект класса HttpsProxyAgent

.contextAsync

Это значение, а не метод, и оно не доступно в классе Safe.

Возвращает объект класса Context, представляющий асинхронный контекст

Пример использования