module MediaWiktory::Wikipedia::Modules::Gettingstartedgetpages

This API is for getting a list of one or more pages related to a particular GettingStarted task.

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

count(value) click to toggle source

Requested count; will attempt to fetch this exact number, but may fetch fewer if no more are found after multiple attempts

@param value [Integer] @return [self]

# File lib/mediawiktory/wikipedia/modules/gettingstartedgetpages.rb, line 41
def count(value)
  merge(gsgpcount: value.to_s)
end
excludedtitle(value) click to toggle source

Full title of a page to exclude from the list; also used as the base title for recommendations based on a given page

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/gettingstartedgetpages.rb, line 33
def excludedtitle(value)
  merge(gsgpexcludedtitle: value.to_s)
end
taskname(value) click to toggle source

Task name, generally either “copyedit” (copy-editing suggestions) or “morelike” (pages similar to the base page/excluded title)

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/gettingstartedgetpages.rb, line 25
def taskname(value)
  merge(gsgptaskname: value.to_s)
end