Interface: ApiGlobalBlockResponse
Defined in: extensions/globalblocks.ts:172
Response of action=globalblock. A failed block/unblock is reported in-band
under the root error key; with alsolocal=1, a failed local block is
reported the same way while the global block still succeeds, so both keys can
appear together — see ApiGlobalBlockLegacyError.
Extends
Properties
batchcomplete?
optionalbatchcomplete?:true
Defined in: envelope/index.ts:178
Present and true when all data for the current batch of pages has been
returned. Continuation may still be ongoing: the generator runs again for
the next batch of pages, and list/meta modules may continue independently.
Serialized as a real boolean under formatversion=2.
Inherited from
curtimestamp?
optionalcurtimestamp?:string
Defined in: envelope/index.ts:187
Current server time (ISO 8601), present when the request set curtimestamp.
Inherited from
error?
optionalerror?:object
Defined in: extensions/globalblocks.ts:177
Legacy errors, when the global block succeeded but the local one failed.
globalblock
globalblock:
ApiGlobalBlockLegacyError[]
errorlang?
optionalerrorlang?:string
Defined in: envelope/index.ts:199
Language error messages are rendered in (responselanginfo=1).
Inherited from
globalblock
globalblock:
ApiGlobalBlockResult
Defined in: extensions/globalblocks.ts:174
Result of action=globalblock.
requestid?
optionalrequestid?:string
Defined in: envelope/index.ts:190
Opaque value echoed back from the request's requestid parameter.
Inherited from
servedby?
optionalservedby?:string
Defined in: envelope/index.ts:184
Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested.
Inherited from
uselang?
optionaluselang?:string
Defined in: envelope/index.ts:196
Language of the interface strings in the response (responselanginfo=1).
Inherited from
warnings?
optionalwarnings?:ApiWarnings
Defined in: envelope/index.ts:193
Non-fatal warnings; shape depends on errorformat (see ApiWarnings).