module MediaWiktory::Wikipedia::Modules::Projectpages
List all pages associated with one or more projects.
The “submodule” (MediaWiki API term) is included in action after setting some param, providing additional tweaking for this param. Example (for {MediaWiktory::Wikipedia::Actions::Query} and its submodules):
“`ruby 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.
Public Instance Methods
@private
# File lib/mediawiktory/wikipedia/modules/projectpages.rb, line 37 def _projects(value) merge(wppprojects: value.to_s, replace: false) end
Also return assessments for the pages returned.
@return [self]
# File lib/mediawiktory/wikipedia/modules/projectpages.rb, line 24 def assessments() merge(wppassessments: 'true') end
When more results are available, use this to continue.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/projectpages.rb, line 53 def continue(value) merge(wppcontinue: value.to_s) end
The maximum number of pages to return.
@param value [Integer, “max”] @return [self]
# File lib/mediawiktory/wikipedia/modules/projectpages.rb, line 45 def limit(value) merge(wpplimit: value.to_s) end
The projects to list pages for. If this parameter is omitted, all projects will be included.
@param values [Array<String>] @return [self]
# File lib/mediawiktory/wikipedia/modules/projectpages.rb, line 32 def projects(*values) values.inject(self) { |res, val| res._projects(val) } end