Module: MediaWiktory::Wikipedia::Modules::Pagepropnames

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

Overview

List all page property names in use on the wiki.

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 (String)

Returns:

  • (self) 


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

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

#limit(value) ⇒ self

The maximum number of names to return.

Parameters:

  • value (Integer, "max")

Returns:

  • (self) 


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

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