WikiListTItemsFromResponse Method

This is preliminary documentation and is subject to change.

From the given MediaWiki API response of the MediaWiki list request, locates the array of items whose items will be processed by ItemFromJson(JToken).

Namespace: WikiClientLibrary.Generators.Primitive
Assembly: WikiClientLibrary (in WikiClientLibrary.dll) Version: 0.8.0+bba8b7a48c3412988f4331f41f4164c670d73663

Syntax

C++

Copy

protected virtual JArray? ItemsFromResponse(
	JToken response
)

Protected Overridable Function ItemsFromResponse ( 
	response As JToken
) As JArray

Dim response As JToken

Dim returnValue As JArray

returnValue = Me.ItemsFromResponse(response)

protected:
virtual JArray^ ItemsFromResponse(
	JToken^ response
)

abstract ItemsFromResponse : 
        response : JToken -> JArray 
override ItemsFromResponse : 
        response : JToken -> JArray

Parameters

response JToken: JSON root of MediaWiki API response. This is usually one page of the list.

Return Value

JArray
a JSON array, or null if response contains no item to yield.

Remarks

The default implementation expects there is an array under JSON path query.{listname} and returns it.

Reference

WikiListT Class

WikiClientLibrary.Generators.Primitive Namespace