Class ReportController

Report controller.

Hierarchy

ReportController

Index

Constructors

constructor

Methods

Constructors

constructor

new ReportController(reportService: ReportService, resourceService: ResourceService): ReportController

- Defined in src/controllers/report/report.controller.ts:35
Parameters
- reportService: ReportService
- resourceService: ResourceService
Returns ReportController

Methods

deleteReport

deleteReport(reportID: string, user: NBUser): Promise<void>

- Defined in src/controllers/report/report.controller.ts:201
Delete a report.

Parameters
- reportID: string
  
  The report's ID.
- user: NBUser
  
  The user.
Returns Promise<void>

deleteReportedBook

deleteReportedBook(reportID: string): Promise<void>

- Defined in src/controllers/report/report.controller.ts:221
Delete a reported book.

Parameters
- reportID: string
  
  The report's ID.
Returns Promise<void>

getAllReports

getAllReports(): Promise<NBReport[]>

- Defined in src/controllers/report/report.controller.ts:103
Get all reports.

Returns Promise<NBReport[]>

All reports.

getBookReport

getBookReport(bookID: string, user: NBUser): Promise<NBReport>

- Defined in src/controllers/report/report.controller.ts:132
Get the user's report for a book.

Parameters
- bookID: string
  
  The book's ID.
- user: NBUser
  
  The user.
Returns Promise<NBReport>

The report.

getBookReports

getBookReports(bookID: string): Promise<NBReport[]>

- Defined in src/controllers/report/report.controller.ts:187
Get all reports for a book.

Parameters
- bookID: string
  
  The book's ID.
Returns Promise<NBReport[]>

All reports for the book.

getReport

getReport(reportID: string, user: NBUser): Promise<NBReport>

- Defined in src/controllers/report/report.controller.ts:83
Get a report.

Parameters
- reportID: string
  
  The report's ID.
- user: NBUser
  
  The user.
Returns Promise<NBReport>

The report.

getUserReportedBooks

getUserReportedBooks(user: NBUser): Promise<NBBook[]>

- Defined in src/controllers/report/report.controller.ts:173
Get all of the books reported by the user.

Parameters
- user: NBUser
  
  The user.
Returns Promise<NBBook[]>

All books reported by the user.

getUserReports

getUserReports(user: NBUser): Promise<NBReport[]>

- Defined in src/controllers/report/report.controller.ts:159
Get all of the user's reports.

Parameters
- user: NBUser
  
  The user.
Returns Promise<NBReport[]>

All reports made by the user.

reportBook

reportBook(bookID: string, reason: string, user: NBUser, hostname: string): Promise<NBReport>

- Defined in src/controllers/report/report.controller.ts:50
Report a book.

Parameters
- bookID: string
  
  The book's ID.
- reason: string
  
  The reason for the report.
- user: NBUser
  
  The user.
- hostname: string
Returns Promise<NBReport>

The new report.

reportedBook

reportedBook(bookID: string, user: NBUser): Promise<boolean>

- Defined in src/controllers/report/report.controller.ts:116
Determine whether or not a user has reported a book.

Parameters
- bookID: string
  
  The book's ID.
- user: NBUser
  
  The user.
Returns Promise<boolean>

Whether or not the user has reported the book.

reportedRecently

reportedRecently(user: NBUser): Promise<boolean>

- Defined in src/controllers/report/report.controller.ts:147
Determine whether or not a user has recently reported a book.

Parameters
- user: NBUser
  
  The user.
Returns Promise<boolean>

Whether or not the user has recently reported a book.

Generated using TypeDoc