Class UserBanListHandler

Hierarchy

UserBanListHandler

Index

Constructors

Methods

addProof create findById findUser list search

Constructors

constructor

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

Methods

addProof

addProof(id, proof): Promise<UserBanList>
Add proof to an existing ban list
Parameters
- id: string | bigint
  
  id of the report
- proof: string[]
  
  list of links to images/files that show proof
Returns Promise<UserBanList>
- Defined in src/client/UserBanListHandler.ts:32

create

create(report): Promise<UserBanList>
Create a new user ban list
Parameters
- report: UserBanListCreateBody
  
  an object containing all the fields to create a report
Returns Promise<UserBanList>
- Defined in src/client/UserBanListHandler.ts:21

findById

findById(id): Promise<UserBanList>
Find a user ban list by id
Parameters
- id: string
  
  id of the report
Returns Promise<UserBanList>
- Defined in src/client/UserBanListHandler.ts:86

findUser

findUser(id): Promise<UserBanList[]>
Find ban lists containing the user id.
Parameters
- id: string
  
  user id to search for
Returns Promise<UserBanList[]>
- Defined in src/client/UserBanListHandler.ts:72

list

list(options?): Promise<UserBanListList>
List all the user ban lists, paginated
Parameters
- Optional options: ListOptions
  
  modify the offset or limit
Returns Promise<UserBanListList>
- Defined in src/client/UserBanListHandler.ts:44

search

search(query, caseInsensitive?): Promise<UserBanList[]>
Finds all ban lists containing the query using full text search.
Parameters
- query: string
  
  query to search for
- caseInsensitive: boolean = false
  
  Disable case sensitivity
Returns Promise<UserBanList[]>
- Defined in src/client/UserBanListHandler.ts:57

Generated using TypeDoc