#Interface: ApiUploadResponse

Defined in: core/upload.ts:112

Response of action=upload.

#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

---

#upload

upload: object

Defined in: core/upload.ts:114

Result of action=upload.

#filekey?

optional filekey?: string

File key when the upload was stashed (stash=1) or published from a stash.

#filename?

optional filename?: string

Stored file name (spaces underscored).

#imageinfo?

optional imageinfo?: ApiUploadImageinfo

Imageinfo for the newly stored revision (added only on Success).

#offset?

optional offset?: number

Chunked-upload byte offset (present on Continue results).

#result

result: string & object | "Success" | "Failure" | "Warning" | "Poll" | "Continue"

Outcome of the upload, set by the result builders (getStashResult, getWarningsResult, getChunkResult, performUpload).

#sessionkey?

optional sessionkey?: string

Session key mirroring filekey on a stashed upload.

#stage?

optional stage?: string & object | "queued" | "uploading" | "assembling"

Async/chunked stage (present on Poll/Continue results).

#warnings?

optional warnings?: ApiUploadWarnings

Recoverable warnings (distinct from the envelope warnings).

---

#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