Class Users

Hierarchy (View Summary)

Base
- Users

Index

Constructors

Methods

avatarMenu clearFavorites disableUploads fixCounts get me search staffFixCounts toggleUploads update updateAvatarCrop updateDmailFilter uploadLimit

Constructors

constructor

new Users(e621: E621, client: Client): Users
Parameters
- e621: E621
- client: Client
Returns Users
Inherited from Base.constructor
- Defined in lib/modules/Base.ts:20

Methods

avatarMenu

avatarMenu(): Promise<UsersAvatarMenuResponse>
Requires Api Key Auth
Get Avatar Menu

Returns Promise<UsersAvatarMenuResponse>

Operation Id
users#avatar_menu

See
Documentation for more details.
- Defined in lib/modules/Users.ts:50

clearFavorites

clearFavorites(idOrName: string | number): Promise<string>
Requires Api Key Auth
Clear User Favorites

You must be Admin+.
Parameters
- idOrName: string | number
Returns Promise<string>

Operation Id
users#flush_favorites

See
Documentation for more details.
- Defined in lib/modules/Users.ts:68

disableUploads

disableUploads(idOrName: string | number, body?: string): Promise<string>
Requires Api Key Auth
Disable User Uploads

You must be Janitor+.
Parameters
- idOrName: string | number
- Optionalbody: string
Returns Promise<string>

Operation Id
users#disable_uploads

See
Documentation for more details.
- Defined in lib/modules/Users.ts:87

fixCounts

fixCounts(): Promise<string>
Requires Api Key Auth
Fix User Counts

Returns Promise<string>

Operation Id
maintenance/user/count_fixes#create

See
Documentation for more details.
- Defined in lib/modules/Users.ts:105

get

get(idOrName: string | number): Promise<FullCurrentUser | FullUser | null>
Get User
Parameters
- idOrName: string | number
Returns Promise<FullCurrentUser | FullUser | null>

Operation Id
users#show

See
Documentation for more details.
- Defined in lib/modules/Users.ts:119

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
users#me

See
Documentation for more details.
- Defined in lib/modules/Users.ts:142

search

search(options?: SearchUsersOptions): Promise<(User<User> | FullCurrentUser)[]>
Users Index
Parameters
- Optionaloptions: SearchUsersOptions
Returns Promise<(User<User> | FullCurrentUser)[]>

Operation Id
users#index

See
Documentation for more details.
- Defined in lib/modules/Users.ts:156

staffFixCounts

staffFixCounts(idOrName: string | number): Promise<string>
Requires Api Key Auth
Staff Fix User Counts

You must be Janitor+.
Parameters
- idOrName: string | number
Returns Promise<string>

Operation Id
users#fix_counts

See
Documentation for more details.
- Defined in lib/modules/Users.ts:178

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
users#toggle_uploads

See
Documentation for more details.
- Defined in lib/modules/Users.ts:199

update

update(
idOrName: string | number,
options: UpdateCurrentUserOptions,
): Promise<null>
Requires Api Key Auth
Update Current User
Parameters
- idOrName: string | number
- options: UpdateCurrentUserOptions
Returns Promise<null>

Operation Id
users#update

See
Documentation for more details.
- Defined in lib/modules/Users.ts:216

updateAvatarCrop

updateAvatarCrop(options: UpdateAvatarCropOptions): Promise<string>
Requires Api Key Auth
Update Avatar Crop
Parameters
- options: UpdateAvatarCropOptions
Returns Promise<string>

Operation Id
maintenance/user/avatars#update

See
Documentation for more details.
- Defined in lib/modules/Users.ts:234

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
maintenance/user/dmail_filters#update

See
Documentation for more details.
- Defined in lib/modules/Users.ts:252

uploadLimit

uploadLimit(
idOrName: string | number,
): Promise<FullCurrentUser | FullUser | null>
Requires Api Key Auth
Get User Upload Limit
Parameters
- idOrName: string | number
Returns Promise<FullCurrentUser | FullUser | null>

Operation Id
users#upload_limit

See
Documentation for more details.
- Defined in lib/modules/Users.ts:272

Class Users

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Users

Methods

avatarMenu

Returns Promise<UsersAvatarMenuResponse>

Operation Id

See

clearFavorites

Parameters

Returns Promise<string>

Operation Id

See

disableUploads

Parameters

Returns Promise<string>

Operation Id

See

fixCounts

Returns Promise<string>

Operation Id

See

get

Parameters

Returns Promise<FullCurrentUser | FullUser | null>

Operation Id

See

me

Returns Promise<FullCurrentUser>

Operation Id

See

search

Parameters

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

Operation Id

See

staffFixCounts

Parameters

Returns Promise<string>

Operation Id

See

toggleUploads

Parameters

Returns Promise<string>

Operation Id

See

update

Parameters

Returns Promise<null>

Operation Id

See

updateAvatarCrop

Parameters

Returns Promise<string>

Operation Id

See

updateDmailFilter

Parameters

Returns Promise<null>

Operation Id

See

uploadLimit

Parameters

Returns Promise<FullCurrentUser | FullUser | null>

Operation Id

See

Settings

On This Page