Interface: ApiSearchTranslationsResponse
Defined in: extensions/translate.ts:604
Response of action=searchtranslations: full-text search over the
translation memories. Only wikis backed by a searchable translation-memory
service return hits; the response carries them with a metadata block under
the root search key.
Extends
Properties
batchcomplete?
optionalbatchcomplete?: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
curtimestamp?
optionalcurtimestamp?:string
Defined in: envelope/index.ts:187
Current server time (ISO 8601), present when the request set curtimestamp.
Inherited from
errorlang?
optionalerrorlang?:string
Defined in: envelope/index.ts:199
Language error messages are rendered in (responselanginfo=1).
Inherited from
requestid?
optionalrequestid?:string
Defined in: envelope/index.ts:190
Opaque value echoed back from the request's requestid parameter.
Inherited from
search
search:
object
Defined in: extensions/translate.ts:605
metadata
metadata:
object
Hit metadata.
metadata.total
total:
number
Total number of hits.
translations
translations:
ApiSearchTranslationsDocument[]
Hits, best match first; [] when nothing matched.
servedby?
optionalservedby?: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
uselang?
optionaluselang?:string
Defined in: envelope/index.ts:196
Language of the interface strings in the response (responselanginfo=1).
Inherited from
warnings?
optionalwarnings?:ApiWarnings
Defined in: envelope/index.ts:193
Non-fatal warnings; shape depends on errorformat (see ApiWarnings).