Interface: ApiBlockResult
Defined in: core/block.ts:16
The block object of an action=block response.
Properties
actionrestrictions?
optionalactionrestrictions?:string[] |null
Defined in: core/block.ts:70
Restricted actions of a partial action block; null when the block
restricts no actions. Only emitted on MediaWiki 1.39–1.44 when
$wgEnablePartialActionBlocks is on.
additionalBlocksStatuses?
optionaladditionalBlocksStatuses?:unknown[] |Record<string,unknown>
Defined in: core/block.ts:85
Extra statuses set by extensions during a successful block; [] when none
is set.
Since
MediaWiki 1.46
allowusertalk
allowusertalk:
boolean
Defined in: core/block.ts:48
Let the blocked user keep editing their own user talk page.
anononly
anononly:
boolean
Defined in: core/block.ts:33
Block only anonymous users editing from an IP address range.
autoblock
autoblock:
boolean
Defined in: core/block.ts:39
Also block the IP addresses this user edits from.
expiry
expiry:
string
Defined in: core/block.ts:27
Expiry timestamp, or infinite for an indefinite block.
hidename
hidename:
boolean
Defined in: core/block.ts:45
Hide the username in logs and contributions.
id
id:
number
Defined in: core/block.ts:24
Block id.
namespacerestrictions
namespacerestrictions:
number[] |null
Defined in: core/block.ts:60
Namespace restrictions of a partial block; null when sitewide.
nocreate
nocreate:
boolean
Defined in: core/block.ts:36
Prevent new account creation from the blocked user or IP range.
noemail
noemail:
boolean
Defined in: core/block.ts:42
Prevent the user from sending email via Special:Emailuser.
pagerestrictions
pagerestrictions:
string[] |null
Defined in: core/block.ts:57
Page restrictions of a partial block; null when sitewide.
partial
partial:
boolean
Defined in: core/block.ts:54
Restrict the block to specific pages or namespaces instead of sitewide.
reason
reason:
string
Defined in: core/block.ts:30
Block reason (echoed back).
timestamp?
optionaltimestamp?:string
Defined in: core/block.ts:77
When the block was applied, in ISO 8601.
Since
MediaWiki 1.47
user
user:
string
Defined in: core/block.ts:18
Blocked user name / IP.
userID
userID:
number
Defined in: core/block.ts:21
Blocked user id (0 for IPs / autoblocks). Note the capital D.
watchlistexpiry?
optionalwatchlistexpiry?:WatchlistExpiry
Defined in: core/block.ts:63
Expiry applied to the watched user page.
watchuser
watchuser:
boolean
Defined in: core/block.ts:51
Add the blocked user's user and talk pages to the blocker's watchlist.