Class SigaaStudentBond

Class to represent student bond.

Hierarchy

SigaaStudentBond

Implements

StudentBond

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SigaaStudentBond(http: HTTP, parser: Parser, courseFactory: CourseFactory, activityFactory: ActivityFactory, program: string, registration: string, bondSwitchUrl: null | URL): SigaaStudentBond

- Defined in src/bonds/sigaa-student-bond.ts:60
Parameters
- http: HTTP
- parser: Parser
- courseFactory: CourseFactory
- activityFactory: ActivityFactory
- program: string
- registration: string
- bondSwitchUrl: null | URL
Returns SigaaStudentBond

Properties

Private Optional _currentPeriod

_currentPeriod: string

Readonly bondSwitchUrl

bondSwitchUrl: null | URL

Readonly program

program: string

It's the name of the student program, in IFSC it is called "curso".

Readonly registration

registration: string

It is the student registration code, in IFSC it is called "matrícula".

Readonly type

type: "student" = 'student'

Methods

getActivities

getActivities(): Promise<Activity[]>

Implementation of StudentBond.getActivities
- Defined in src/bonds/sigaa-student-bond.ts:219
Returns Promise<Activity[]>

getCourses

getCourses(allPeriods?: boolean): Promise<CourseStudent[]>

Implementation of StudentBond.getCourses
- Defined in src/bonds/sigaa-student-bond.ts:77
Get courses, in IFSC it is called "Turmas Virtuais".

Parameters
- allPeriods: boolean = false
  
  if true, all courses will be returned; otherwise, only latest courses.
Returns Promise<CourseStudent[]>

Promise with array of courses.

getCurrentPeriod

getCurrentPeriod(): Promise<string>

Implementation of StudentBond.getCurrentPeriod
- Defined in src/bonds/sigaa-student-bond.ts:302
Returns Promise<string>

Generated using TypeDoc