Class Users

constructor

• new Users(e621: E621, client: Client): Users

  Parameters

  • e621: E621
  • client: Client

  Returns Users

dmails

avatarMenu

• avatarMenu(): Promise<UserAvatarMenu>
  Requires Api Key Auth

  Get Avatar Menu

  Returns Promise<UserAvatarMenu>

  Operation Id

  getAvatarMenu

  See

  Documentation for more details.

clearFavorites

• clearFavorites(idOrName: string | number): Promise<unknown>
  Requires Api Key Auth

  Clear User Favorites

  You must be Admin+.

  Parameters

  • idOrName: string | number

  Returns Promise<unknown>

  Operation Id

  clearUserFavorites

  See

  Documentation for more details.

disableUploads

• disableUploads(idOrName: string | number, body?: string): Promise<unknown>
  Requires Api Key Auth

  Disable User Uploads

  You must be Janitor+.

  Parameters

  • idOrName: string | number
  • Optionalbody: string

  Returns Promise<unknown>

  Operation Id

  disableUserUploads

  See

  Documentation for more details.

fixCounts

• fixCounts(): Promise<unknown>
  Requires Api Key Auth

  Fix User Counts

  Returns Promise<unknown>

  Operation Id

  fixUserCounts

  See

  Documentation for more details.

get

• get(idOrName: string | number): Promise<FullCurrentUser | FullUser | null>

  Get User

  Parameters

  • idOrName: string | number

  Returns Promise<FullCurrentUser | FullUser | null>

  Operation Id

  getUser

  See

  Documentation for more details.

me

• me(): Promise<FullCurrentUser>

  Get Current User

  This will return the default settings for anonymous users if no authentication is used. This most interesting part is probably the default blacklist, located in blacklisted_tags.

  Returns Promise<FullCurrentUser>

  Operation Id

  getMe

  See

  Documentation for more details.

search

• search(options?: SearchUsersOptions): Promise<(User<User> | FullCurrentUser)[]>

  Search Users

  Parameters

  • Optionaloptions: SearchUsersOptions

  Returns Promise<(User<User> | FullCurrentUser)[]>

  Operation Id

  searchUsers

  See

  Documentation for more details.

staffFixCounts

• staffFixCounts(idOrName: string | number): Promise<unknown>
  Requires Api Key Auth

  Staff Fix User Counts

  You must be Janitor+.

  Parameters

  • idOrName: string | number

  Returns Promise<unknown>

  Operation Id

  staffFixUserCounts

  See

  Documentation for more details.

toggleUploads

• toggleUploads(idOrName: string | number): Promise<string>
  Requires Api Key Auth

  Toggle User Uploads

  You must be Janitor+. This endpoint will return HTML when disabling uploads (due to a reason being required), this endpoint should only be used for reenabling. Use Disable User Uploads to disable uploads.

  Parameters

  • idOrName: string | number

  Returns Promise<string>

  Operation Id

  toggleUserUploads

  See

  Documentation for more details.

updateDmailFilter

• updateDmailFilter(dmail_id: number, words: string): Promise<null>
  Requires Api Key Auth

  Update User Dmail Filter

  Parameters

  • dmail_id: number
  • words: string

  Returns Promise<null>

  Operation Id

  updateUserDmailFilter

  See

  Documentation for more details.

uploadLimit

• uploadLimit(idOrName: string | number): Promise<User<User> | null>
  Requires Api Key Auth

  Get User Upload Limit

  Parameters

  • idOrName: string | number

  Returns Promise<User<User> | null>

  Operation Id

  getUserUploadLimit

  See

  Documentation for more details.