For AI agents: the complete documentation index is available at https://types-mediawiki-response.pages.dev/llms.txt, the full documentation bundle is available at https://types-mediawiki-response.pages.dev/llms-full.txt, and this page is available as Markdown at https://types-mediawiki-response.pages.dev/api/extensions/visualeditor/ApiVisualEditorPageFrame.md.
  • English
  • Interface: ApiVisualEditorPageFrame

    Defined in: extensions/visualeditor.ts:104

    The page frame both visualeditor and visualeditoredit return.

    Properties

    cachekey?

    optional cachekey?: string

    Defined in: extensions/visualeditor.ts:154

    Key into the serialisation cache, from visualeditoredit paction=serializeforcache.


    categorieshtml?

    optional categorieshtml?: string

    Defined in: extensions/visualeditor.ts:121

    Category bar HTML.


    content?

    optional content?: string

    Defined in: extensions/visualeditor.ts:109

    Rendered page body (HTML for parse, wikitext for wikitext).


    contentSub?

    optional contentSub?: string

    Defined in: extensions/visualeditor.ts:115

    Page subtitle ("Revision as of …") HTML.


    diff?

    optional diff?: string

    Defined in: extensions/visualeditor.ts:151

    HTML diff, from visualeditoredit paction=diff.


    displayTitleHtml?

    optional displayTitleHtml?: string

    Defined in: extensions/visualeditor.ts:118

    Display title HTML.


    edit?

    optional edit?: ApiEditResult

    Defined in: extensions/visualeditor.ts:160

    The underlying action=edit result, on the save failure branch (result: "error").


    isRedirect?

    optional isRedirect?: string

    Defined in: extensions/visualeditor.ts:136

    Empty string for a normal page — this is the legacy empty-string flag pattern rather than a boolean.


    jsconfigvars?

    optional jsconfigvars?: Record<string, unknown>

    Defined in: extensions/visualeditor.ts:130

    ResourceLoader config variables (e.g. wgEchoSeenTime).


    lastModified?

    optional lastModified?: ApiLastModified

    Defined in: extensions/visualeditor.ts:139

    When the page last changed, in display parts.


    modules?

    optional modules?: string[]

    Defined in: extensions/visualeditor.ts:127

    ResourceLoader modules the response needs.


    newrevid?

    optional newrevid?: number

    Defined in: extensions/visualeditor.ts:142

    New revision id, from visualeditoredit paction=save.


    nocontent?

    optional nocontent?: true

    Defined in: extensions/visualeditor.ts:157

    true when the save asked to skip the re-render (nocontent parameter), so no content follows.


    preloaded?

    optional preloaded?: boolean

    Defined in: extensions/visualeditor.ts:112

    Whether content came from a preload rather than the page.


    result?

    optional result?: "error" | "success"

    Defined in: extensions/visualeditor.ts:106

    Outcome of the request; error on the save-failure branch.


    sections?

    optional sections?: unknown[]

    Defined in: extensions/visualeditor.ts:124

    Section index of the edited/loaded page.


    tempusercreated?

    optional tempusercreated?: true

    Defined in: extensions/visualeditor.ts:163

    true when a temporary account was created by this edit.


    tempusercreatedredirect?

    optional tempusercreatedredirect?: string

    Defined in: extensions/visualeditor.ts:166

    Redirect URL for a just-created temporary account, when one applies.


    watched?

    optional watched?: boolean

    Defined in: extensions/visualeditor.ts:145

    Whether the editor watches the page now.


    watchlistexpiry?

    optional watchlistexpiry?: WatchlistExpiry

    Defined in: extensions/visualeditor.ts:148

    When that watch expires; null when permanent.