For AI agents: the complete documentation index is available at https://types-mediawiki-response.pages.dev/zh/llms.txt, the full documentation bundle is available at https://types-mediawiki-response.pages.dev/zh/llms-full.txt, and this page is available as Markdown at https://types-mediawiki-response.pages.dev/zh/api/core/ApiLoginResponse.md.
types-mediawiki-response
  • 中文

      • Interface: ApiLoginResponse

      Defined in: core/login.ts:18

      Response of the deprecated action=login.

      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

      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

      login

      login: object

      Defined in: core/login.ts:20

      Result of action=login.

      lguserid?

      optional lguserid?: number

      User id of the logged-in account (legacy lguserid spelling).

      lgusername?

      optional lgusername?: string

      User name of the logged-in account (legacy lgusername spelling).

      reason?

      optional reason?: string | ApiMessage

      Why the login failed, emitted when result is Failed or Aborted: a plain string under the default (bc) errorformat, an ApiMessage under a modern one.

      result

      result: string & object | "Success" | "Failed" | "NeedToken" | "WrongToken" | "Aborted"

      Login outcome.

      token?

      optional token?: string

      Login token echoed back on a NeedToken round trip.

      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