Class FullUser

Schema

See

Documentation for more details.

Hierarchy (View Summary)

FullUser
User<FullUserData>
- FullUser

Index

Constructors

Methods

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

Constructors

constructor

new FullUser(e621: E621, data: FullUser): FullUser
Parameters
- e621: E621
- data: FullUser
Returns FullUser
Inherited from User.constructor
- Defined in lib/models/Base.ts:10

Methods

[custom]

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

adminEdit

adminEdit(options: UpdateStaffUserOptions): Promise<null>
Requires Api Key Auth
Admin Edit User

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 User.adminEdit
- Defined in lib/models/User.ts:30

anonymize

anonymize(): Promise<unknown>
Requires Api Key Auth
Admin Anonymize User

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 User.anonymize
- Defined in lib/models/User.ts:46

clearFavorites

clearFavorites(): Promise<unknown>
Requires Api Key Auth
Clear User Favorites

You must be Admin+.

Returns Promise<unknown>

Operation Id
users#flush_favorites

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

disableUploads

disableUploads(reason?: string): Promise<string>
Requires Api Key Auth
Disable User Uploads

You must be Janitor+.
Parameters
- Optionalreason: string
Returns Promise<string>

Operation Id
users#disable_uploads

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

fixCounts

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

Returns Promise<unknown>

Operation Id
maintenance/user/count_fixes#create

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

staffFixCounts

staffFixCounts(): Promise<unknown>
Requires Api Key Auth
Staff Fix User Counts

You must be Janitor+.

Returns Promise<unknown>

Operation Id
users#fix_counts

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

toggleUploads

toggleUploads(): 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.

Returns Promise<string>

Operation Id
users#toggle_uploads

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

toJSON

toJSON(): FullUser
Returns FullUser
Inherited from User.toJSON
- Defined in lib/models/Base.ts:40

uploadLimit

uploadLimit(): Promise<User<User>>
Requires Api Key Auth
Get User Upload Limit

Returns Promise<User<User>>

Operation Id
users#upload_limit

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