Interface CourseForum

Hierarchy

UpdatableResource<ForumData>
- CourseForum

Implemented by

SigaaCourseForum

Index

Properties

Methods

Properties

Readonly _instanceIndentifier

_instanceIndentifier: string

Readonly title

title: string

Readonly type

type: "forum"

Methods

close

close(): void

Inherited from UpdatableResource.close
- Defined in src/resources/updatable-resource.ts:12
Returns void

getAuthor

getAuthor(): Promise<string>

- Defined in src/courses/resources/forum/sigaa-course-forum-student.ts:90
Post author

Returns Promise<string>

getCreationDate

getCreationDate(): Promise<Date>

- Defined in src/courses/resources/forum/sigaa-course-forum-student.ts:105
creation date of the forum.

Returns Promise<Date>

getFile

getFile(): Promise<undefined | File>

- Defined in src/courses/resources/forum/sigaa-course-forum-student.ts:94
File attached to the forum.

Returns Promise<undefined | File>

getFlagMonitorReading

getFlagMonitorReading(): Promise<boolean>

- Defined in src/courses/resources/forum/sigaa-course-forum-student.ts:66
If read monitoring is enabled.

Returns Promise<boolean>

getForumType

getForumType(): Promise<string>

- Defined in src/courses/resources/forum/sigaa-course-forum-student.ts:98
Like 'Uma única discussão simples'

Returns Promise<string>

getNumOfTopics

getNumOfTopics(): Promise<number>

- Defined in src/courses/resources/forum/sigaa-course-forum-student.ts:71
Number of topics

Returns Promise<number>

postTopic

postTopic(title: string, body: string, file: string, notify: boolean): Promise<void>

- Defined in src/courses/resources/forum/sigaa-course-forum-student.ts:80
Post topic in forum

Parameters
- title: string
  
  title of topic
- body: string
  
  body of topic
- file: string
  
  buffer of file attachment
- notify: boolean
  
  if notify members
Returns Promise<void>

update

update(T: ForumData): void

Inherited from UpdatableResource.update
- Defined in src/resources/updatable-resource.ts:10
Parameters
- T: ForumData
Returns void

Generated using TypeDoc