Skip to content

Commit

Permalink
add doc
Browse files Browse the repository at this point in the history
  • Loading branch information
AsakuraMizu committed May 8, 2024
1 parent 98fe542 commit f7d0d4f
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,10 @@ It's ok if you meet `Timeout * Async callback was not invoked within the 5000ms

## Changelog

- (unreleased)
- Get file categories of course
- Get file list by category (currently not supported in TA)
- Fix file download url and visit count in TA
- v3.1.4
- Allow and check for undefined credential in login (see [#52](https://github.com/Harry-Chen/Learn-Helper/issues/52))
- Discriminate `getAllContents` return type based on input content type (see [#53](https://github.com/Harry-Chen/Learn-Helper/issues/53))
Expand Down
5 changes: 5 additions & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -467,6 +467,7 @@ export class Learn2018Helper {
});
}

/** Get file categories of the specified course. */
public async getFileCategoryList(
courseID: string,
courseType: CourseType = CourseType.STUDENT,
Expand All @@ -491,6 +492,10 @@ export class Learn2018Helper {
);
}

/**
* Get all files of the specified category of the specified course.
* Note: this cannot get `visitCount` and `downloadCount`
*/
public async getFileListByCategory(
courseID: string,
categoryId: string,
Expand Down

0 comments on commit f7d0d4f

Please sign in to comment.