#Interface: ApiVisualEditorResponse

Defined in: extensions/visualeditor.ts:175

Response of action=visualeditor for paction=parse, wikitext and metadata, which share one payload. The other paction values return different shapes — see ApiVisualEditorTemplatesUsedResponse and ApiVisualEditorParseFragmentResponse.

#Extends

• ApiEnvelope

#Properties

#batchcomplete?

optional batchcomplete?: 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

ApiEnvelope.batchcomplete

---

#curtimestamp?

optional curtimestamp?: string

Defined in: envelope/index.ts:187

Current server time (ISO 8601), present when the request set curtimestamp.

#Inherited from

ApiEnvelope.curtimestamp

---

#errorlang?

optional errorlang?: string

Defined in: envelope/index.ts:199

Language error messages are rendered in (responselanginfo=1).

#Inherited from

ApiEnvelope.errorlang

---

#requestid?

optional requestid?: string

Defined in: envelope/index.ts:190

Opaque value echoed back from the request's requestid parameter.

#Inherited from

ApiEnvelope.requestid

---

#servedby?

optional servedby?: 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

ApiEnvelope.servedby

---

#uselang?

optional uselang?: string

Defined in: envelope/index.ts:196

Language of the interface strings in the response (responselanginfo=1).

#Inherited from

ApiEnvelope.uselang

---

#visualeditor

visualeditor: ApiVisualEditorPageFrame & object

Defined in: extensions/visualeditor.ts:177

Result of action=visualeditor for the paction values sharing this payload.

#Type Declaration

#basetimestamp

basetimestamp: string

Base timestamp for edit-conflict detection.

#blockinfo

blockinfo: ApiBlockInfo | null

Block state of the requesting user; null when not blocked.

#canEdit

canEdit: boolean

Whether the user may edit this page at all.

#checkboxesDef

checkboxesDef: unknown[] | Record<string, ApiVisualEditorCheckboxDef>

Definitions of the save-form fields, keyed by element id. An empty PHP map, so [] when no field applies to the requesting user.

#checkboxesMessages

checkboxesMessages: unknown[] | Record<string, string>

Plain text of the messages referenced by checkboxesDef. An empty PHP map, so [] when there are no messages.

#copyrightWarning

copyrightWarning: string

Copyright warning HTML; "" when none applies.

#etag?

optional etag?: string

Restbase/Parsoid ETag for conditional requests.

#notices

notices: unknown[] | Record<string, string>

Notices the editor should show above the form, keyed by message name (e.g. newarticletext for a page that does not exist yet). An empty PHP map, so [] when there is nothing to show.

#oldid

oldid: number

Revision id the content was taken from.

#protectedClasses

protectedClasses: string

CSS classes for protection state, joined into one string ("" when none).

#starttimestamp

starttimestamp: string

Server timestamp when the request started.

#wouldautocreate?

optional wouldautocreate?: boolean

Whether an auto-created temporary account would be used for the edit.

#Since

MediaWiki 1.41

---

#warnings?

optional warnings?: ApiWarnings

Defined in: envelope/index.ts:193

Non-fatal warnings; shape depends on errorformat (see ApiWarnings).

#Inherited from

ApiEnvelope.warnings