Class SigaaSearchTeacherResult

Hierarchy

SigaaSearchTeacherResult

Implements

TeacherResult

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new SigaaSearchTeacherResult(http: HTTP, parser: Parser, options: TeacherResultData): SigaaSearchTeacherResult

- Defined in src/search/sigaa-search-teacher-result.ts:49
Parameters
- http: HTTP
- parser: Parser
- options: TeacherResultData
Returns SigaaSearchTeacherResult

Properties

Private _department

_department: string

Private _name

_name: string

Private _pageURL

_pageURL: URL

Private Optional _photoURL

_photoURL: URL

Accessors

department

get department(): string

Implementation of TeacherResult.department
- Defined in src/search/sigaa-search-teacher-result.ts:104
Returns string

name

get name(): string

Implementation of TeacherResult.name
- Defined in src/search/sigaa-search-teacher-result.ts:83
Returns string

pageURL

get pageURL(): URL

Implementation of TeacherResult.pageURL
- Defined in src/search/sigaa-search-teacher-result.ts:108
Returns URL

profilePictureURL

get profilePictureURL(): undefined | URL

Implementation of TeacherResult.profilePictureURL
- Defined in src/search/sigaa-search-teacher-result.ts:87
Returns undefined | URL

Methods

downloadProfilePicture

downloadProfilePicture(basepath: string, callback: ProgressCallback): Promise<string>

Implementation of TeacherResult.downloadProfilePicture
- Defined in src/search/sigaa-search-teacher-result.ts:91
Download user profile picture, save in basepath Returns the destination of the file on the file system Throws an exception if the teacher does not have a photo

Parameters
- basepath: string
- callback: ProgressCallback
Returns Promise<string>

getEmail

getEmail(): Promise<undefined | string>

Implementation of TeacherResult.getEmail
- Defined in src/search/sigaa-search-teacher-result.ts:60
May return undefined if the teacher has no registered email

Returns Promise<undefined | string>

Generated using TypeDoc