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/echo/ApiEchoPushSubscriptionsResponse.md.
types-mediawiki-response
  • English

      • Interface: ApiEchoPushSubscriptionsResponse

      Defined in: extensions/echo.ts:372

      Responses of action=echopushsubscriptions: the command value is the response key (create or delete). The module is experimental and only registered when $wgEchoEnablePush is on.

      Extends

      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

      create?

      optional create?: object

      Defined in: extensions/echo.ts:374

      command=create — the subscription was stored.

      result?

      optional result?: "Success"

      Success sentinel; a rejected call comes back as a top-level error.

      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

      delete?

      optional delete?: object

      Defined in: extensions/echo.ts:380

      command=delete — the subscription was removed.

      result?

      optional result?: "Success"

      Success sentinel; a rejected call comes back as a top-level error.

      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

      warnings?

      optional warnings?: ApiWarnings

      Defined in: envelope/index.ts:193

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

      Inherited from

      ApiEnvelope.warnings