Class FullCurrentUser

Schema

FullCurrentUser

See

Documentation for more details.

Hierarchy (View Summary)

FullCurrentUser
CurrentUser<FullCurrentUserData>
- FullCurrentUser

Index

Constructors

Properties

last_logged_in_at

Methods

[custom] adminEdit anonymize avatarMenu clearFavorites disableUploads fixCounts staffFixCounts toggleUploads toJSON update updateAvatarCrop uploadLimit

Constructors

constructor

new FullCurrentUser(
e621: E621<NoV2Options>,
data: FullCurrentUser,
): FullCurrentUser
Parameters
- e621: E621<NoV2Options>
- data: FullCurrentUser
Returns FullCurrentUser
Inherited from CurrentUser.constructor
- Defined in lib/models/Base.ts:11

Properties

last_logged_in_at

last_logged_in_at: string

Narrowed from User.last_logged_in_at - always present for the current user.

Methods

[custom]

"[custom]"(_depth: never, opts: InspectOptions): string
Parameters
- _depth: never
- opts: InspectOptions
Returns string
Inherited from CurrentUser.[custom]
- Defined in lib/models/Base.ts:19

adminEdit

adminEdit(options: UpdateStaffUserOptions): Promise<null>
Requires Api Key Auth
You must be Admin+. If editing an Admin+, you must be Owner+.
Parameters
- options: UpdateStaffUserOptions
Returns Promise<null>

Operation Id
staff/users#update

See
Documentation for more details.
Inherited from CurrentUser.adminEdit
- Defined in lib/models/User.ts:29

anonymize

anonymize(): Promise<unknown>
Requires Api Key Auth
You must have the bd staff user flag. Cannot be used on staff.

Returns Promise<unknown>

Operation Id
staff/users#anonymize_confirm

See
Documentation for more details.
Inherited from CurrentUser.anonymize
- Defined in lib/models/User.ts:44

avatarMenu

avatarMenu(): Promise<UsersAvatarMenuResponse>
Requires Api Key Auth
Returns Promise<UsersAvatarMenuResponse>

Operation Id
users#avatar_menu

See
Documentation for more details.
Inherited from CurrentUser.avatarMenu
- Defined in lib/models/CurrentUser.ts:32

clearFavorites

clearFavorites(): Promise<unknown>
Requires Api Key Auth
You must be Admin+.

Returns Promise<unknown>

Operation Id
users#flush_favorites

See
Documentation for more details.
Inherited from CurrentUser.clearFavorites
- Defined in lib/models/User.ts:59

disableUploads

disableUploads(reason?: string): Promise<string>
Requires Api Key Auth
You must be Janitor+.
Parameters
- Optionalreason: string
Returns Promise<string>

Operation Id
users#disable_uploads

See
Documentation for more details.
Inherited from CurrentUser.disableUploads
- Defined in lib/models/User.ts:74

fixCounts

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

Operation Id
maintenance/user/count_fixes#create

See
Documentation for more details.
Inherited from CurrentUser.fixCounts
- Defined in lib/models/User.ts:87

staffFixCounts

staffFixCounts(): Promise<unknown>
Requires Api Key Auth
You must be Janitor+.

Returns Promise<unknown>

Operation Id
users#fix_counts

See
Documentation for more details.
Inherited from CurrentUser.staffFixCounts
- Defined in lib/models/User.ts:102

toggleUploads

toggleUploads(): Promise<string>
Requires Api Key Auth
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.

Returns Promise<string>

Operation Id
users#toggle_uploads

See
Documentation for more details.
Inherited from CurrentUser.toggleUploads
- Defined in lib/models/User.ts:119

toJSON

toJSON(): FullCurrentUser
Returns FullCurrentUser
Inherited from CurrentUser.toJSON
- Defined in lib/models/Base.ts:41

update

update(options: UpdateCurrentUserOptions): Promise<null>
Requires Api Key Auth
Parameters
- options: UpdateCurrentUserOptions
Returns Promise<null>

Operation Id
users#update

See
Documentation for more details.
Inherited from CurrentUser.update
- Defined in lib/models/CurrentUser.ts:45

updateAvatarCrop

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

Operation Id
maintenance/user/avatars#update

See
Documentation for more details.
Inherited from CurrentUser.updateAvatarCrop
- Defined in lib/models/CurrentUser.ts:58

uploadLimit

uploadLimit(): Promise<User<User>>
Requires Api Key Auth
Returns Promise<User<User>>

Operation Id
users#upload_limit

See
Documentation for more details.
Inherited from CurrentUser.uploadLimit
- Defined in lib/models/User.ts:132