Class ReportService

Report table service.

Hierarchy

ReportService

Index

Constructors

constructor

Methods

Constructors

constructor

new ReportService(dbService: DBService, resourceService: ResourceService, userService: UserService, bookService: BookService): ReportService

- Defined in src/services/report/report.service.ts:25
Parameters
- dbService: DBService
- resourceService: ResourceService
- userService: UserService
- bookService: BookService
Returns ReportService

Methods

deleteReport

deleteReport(reportID: string): Promise<void>

- Defined in src/services/report/report.service.ts:245
Delete a report.

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

deleteReportedBook

deleteReportedBook(reportID: string): Promise<void>

- Defined in src/services/report/report.service.ts:254
Delete a reported book and all reports associated with it.

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

getBookReports

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

- Defined in src/services/report/report.service.ts:230
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): Promise<NBReport>

- Defined in src/services/report/report.service.ts:99
Get a report.

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

The report record.

getReports

getReports(): Promise<NBReport[]>

- Defined in src/services/report/report.service.ts:117
Get all reports.

Returns Promise<NBReport[]>

All reports.

getUserBookReport

getUserBookReport(userID: string, bookID: string): Promise<NBReport>

- Defined in src/services/report/report.service.ts:149
Get a user report for a book.

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

The report.

getUserBookReports

getUserBookReports(userID: string): Promise<NBReport[]>

- Defined in src/services/report/report.service.ts:190
Get all reports made by a user.

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

All reports made by the user.

getUserReportedBooks

getUserReportedBooks(userID: string): Promise<NBBook[]>

- Defined in src/services/report/report.service.ts:206
Get all books reported by a user.

Parameters
- userID: string
  
  The user's ID.
Returns Promise<NBBook[]>

All books reported by the user.

reportBook

reportBook(userID: string, bookID: string, reason: string): Promise<NBReport>

- Defined in src/services/report/report.service.ts:44
Report a book.

Parameters
- userID: string
  
  The ID of the user reporting the book.
- bookID: string
  
  The book's ID.
- reason: string
  
  The reason for reporting.
Returns Promise<NBReport>

The new book record.

reportExists

reportExists(reportID: string): Promise<boolean>

- Defined in src/services/report/report.service.ts:85
Determine whether or not a report exists.

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

Whether or not the report exists.

userReportedBook

userReportedBook(userID: string, bookID: string): Promise<boolean>

- Defined in src/services/report/report.service.ts:131
Determine whether or not a user has reported a book.

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

Whether or not the user has reported the book.

userReportedRecently

userReportedRecently(userID: string): Promise<boolean>

- Defined in src/services/report/report.service.ts:171
Determine whether or not a user has recently reported a book.

Parameters
- userID: string
  
  The user's ID.
Returns Promise<boolean>

Whether or not the user has recently reported a book.

Generated using TypeDoc