Class ContentHandler

Hierarchy

ContentHandler

Index

Constructors

Methods

create find findById list search

Constructors

constructor

new ContentHandler(axiosInstance): ContentHandler
Parameters
- axiosInstance: AxiosInstance
Returns ContentHandler
- Defined in src/client/ContentHandler.ts:13

Methods

create

create(report): Promise<ContentReport>
Create a content report
Parameters
- report: ContentReportCreateBody
  
  an object containing all the fields to create a report
Returns Promise<ContentReport>
- Defined in src/client/ContentHandler.ts:21

find

find(query, caseInsensitive?): Promise<ContentReport[]>
Finds all content reports containing the query in the link.
Parameters
- query: string
  
  query to search for
- caseInsensitive: boolean = false
  
  Disable case sensitivity
Returns Promise<ContentReport[]>
- Defined in src/client/ContentHandler.ts:57

findById

findById(id): Promise<ContentReport>
Find a content report by id
Parameters
- id: string | bigint
  
  id of the report
Returns Promise<ContentReport>
- Defined in src/client/ContentHandler.ts:46

list

list(options?): Promise<List<ContentReport>>
List all the content reports, paginated
Parameters
- Optional options: ListOptions
  
  modify the offset or limit
Returns Promise<List<ContentReport>>
- Defined in src/client/ContentHandler.ts:34

search

search(query, caseInsensitive?): Promise<ContentReport[]>
Finds all content reports containing the query using full text search.
Parameters
- query: string
  
  query to search for
- caseInsensitive: boolean = false
  
  Disable case sensitivity
Returns Promise<ContentReport[]>
- Defined in src/client/ContentHandler.ts:73

Generated using TypeDoc