Interface: ApiGlobalBlock
Defined in: extensions/globalblocks.ts:31
One global block record. bgprop controls which fields appear. From
MediaWiki 1.43 the flag booleans below are real booleans (false included),
emitted together with bgprop=target (also for the deprecated
bgprop=address); earlier versions emit a flag only when the option
applies, regardless of bgprop.
Properties
account-creation-disabled?
optionalaccount-creation-disabled?:boolean
Defined in: extensions/globalblocks.ts:82
Whether account creation is disabled by the block. A real boolean.
Since
MediaWiki 1.43
address?
optionaladdress?:string
Defined in: extensions/globalblocks.ts:39
Blocked user name / IP or range. bgprop=address — the deprecated
spelling of bgprop=target.
anononly?
optionalanononly?:boolean
Defined in: extensions/globalblocks.ts:75
Whether the block affects only anonymous users. A real boolean.
autoblocking-enabled?
optionalautoblocking-enabled?:boolean
Defined in: extensions/globalblocks.ts:96
Whether autoblocking is enabled for the block. A real boolean.
Since
MediaWiki 1.43
automatic?
optionalautomatic?:boolean
Defined in: extensions/globalblocks.ts:103
Whether this is an automatic (autoblock) block. A real boolean.
Since
MediaWiki 1.43
block-email?
optionalblock-email?:boolean
Defined in: extensions/globalblocks.ts:89
Whether the block forbids sending email. A real boolean.
Since
MediaWiki 1.46
by?
optionalby?:string
Defined in: extensions/globalblocks.ts:48
Name of the global blocker. bgprop=by.
bywiki?
optionalbywiki?:string
Defined in: extensions/globalblocks.ts:51
Wiki the blocking user acted from, e.g. mediawikiwiki. bgprop=by.
expiry?
optionalexpiry?:string
Defined in: extensions/globalblocks.ts:57
When the block expires, or infinity. bgprop=expiry.
id?
optionalid?:string
Defined in: extensions/globalblocks.ts:33
Block id (a string under fv2). bgprop=id.
rangeend?
optionalrangeend?:string
Defined in: extensions/globalblocks.ts:72
End of the blocked IP range. bgprop=range; absent for autoblocks,
which hide their target.
rangestart?
optionalrangestart?:string
Defined in: extensions/globalblocks.ts:66
Start of the blocked IP range. bgprop=range; absent for autoblocks,
which hide their target.
reason?
optionalreason?:string
Defined in: extensions/globalblocks.ts:60
Block reason. bgprop=reason.
target?
optionaltarget?:string
Defined in: extensions/globalblocks.ts:45
Blocked user name / IP or range. bgprop=target; absent for autoblocks,
which hide their target.
timestamp?
optionaltimestamp?:string
Defined in: extensions/globalblocks.ts:54
When the block was applied. bgprop=timestamp.