Module: MediaWiktory::Wikipedia::Modules::Mapdata

Defined in:
lib/mediawiktory/wikipedia/modules/mapdata.rb

Overview

Request all map data from the page Metallica

The "submodule" (MediaWiki API term) is included in action after setting some param, providing additional tweaking for this param. Example (for Actions::Query and its submodules):

api.query             # returns Actions::Query
   .prop(:revisions)  # adds prop=revisions to action URL, and includes Modules::Revisions into action
   .limit(10)         # method of Modules::Revisions, adds rvlimit=10 to URL

All submodule's parameters are documented as its public methods, see below.

Instance Method Summary collapse

Instance Method Details

#continue(value) ⇒ self

When more results are available, use this to continue.

Parameters:

  • value (Integer)

Returns:

  • (self) 


41
42
43
 
# File 'lib/mediawiktory/wikipedia/modules/mapdata.rb', line 41

def continue(value)
  merge(mpdcontinue: value.to_s)
end

#groups(value) ⇒ self

Pipe-separated groups to return data for

Parameters:

  • value (String)

Returns:

  • (self) 


25
26
27
 
# File 'lib/mediawiktory/wikipedia/modules/mapdata.rb', line 25

def groups(value)
  merge(mpdgroups: value.to_s)
end

#limit(value) ⇒ self

Data for how many pages to return

Parameters:

  • value (Integer, "max")

Returns:

  • (self) 


33
34
35
 
# File 'lib/mediawiktory/wikipedia/modules/mapdata.rb', line 33

def limit(value)
  merge(mpdlimit: value.to_s)
end