module MediaWiktory::Wikipedia::Modules::GAllpages

Enumerate all pages sequentially in a given namespace. _Generator module: for fetching pages corresponding to request._

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

_dir(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/g-allpages.rb, line 151
def _dir(value)
  defined?(super) && super || ["ascending", "descending"].include?(value.to_s) && merge(gapdir: value.to_s)
end
_filterredir(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/g-allpages.rb, line 75
def _filterredir(value)
  defined?(super) && super || ["all", "redirects", "nonredirects"].include?(value.to_s) && merge(gapfilterredir: value.to_s)
end
_namespace(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/g-allpages.rb, line 62
def _namespace(value)
  defined?(super) && super || ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "100", "101", "108", "109", "118", "119", "446", "447", "710", "711", "828", "829", "2300", "2301", "2302", "2303"].include?(value.to_s) && merge(gapnamespace: value.to_s)
end
_prexpiry(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/g-allpages.rb, line 177
def _prexpiry(value)
  defined?(super) && super || ["indefinite", "definite", "all"].include?(value.to_s) && merge(gapprexpiry: value.to_s)
end
_prfiltercascade(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/g-allpages.rb, line 130
def _prfiltercascade(value)
  defined?(super) && super || ["cascading", "noncascading", "all"].include?(value.to_s) && merge(gapprfiltercascade: value.to_s)
end
_prlevel(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/g-allpages.rb, line 117
def _prlevel(value)
  defined?(super) && super || ["autoconfirmed", "extendedconfirmed", "templateeditor", "sysop"].include?(value.to_s) && merge(gapprlevel: value.to_s, replace: false)
end
_prtype(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/g-allpages.rb, line 104
def _prtype(value)
  defined?(super) && super || ["edit", "move", "upload"].include?(value.to_s) && merge(gapprtype: value.to_s, replace: false)
end
continue(value) click to toggle source

When more results are available, use this to continue.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-allpages.rb, line 33
def continue(value)
  merge(gapcontinue: value.to_s)
end
dir(value) click to toggle source

The direction in which to list.

@param value [String] One of “ascending”, “descending”. @return [self]

# File lib/mediawiktory/wikipedia/modules/g-allpages.rb, line 146
def dir(value)
  _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}"
end
filterredir(value) click to toggle source

Which pages to list.

@param value [String] One of “all”, “redirects”, “nonredirects”. @return [self]

# File lib/mediawiktory/wikipedia/modules/g-allpages.rb, line 70
def filterredir(value)
  _filterredir(value) or fail ArgumentError, "Unknown value for filterredir: #{value}"
end
from(value) click to toggle source

The page title to start enumerating from.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-allpages.rb, line 25
def from(value)
  merge(gapfrom: value.to_s)
end
limit(value) click to toggle source

How many total pages to return.

@param value [Integer, “max”] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-allpages.rb, line 138
def limit(value)
  merge(gaplimit: value.to_s)
end
maxsize(value) click to toggle source

Limit to pages with at most this many bytes.

@param value [Integer] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-allpages.rb, line 91
def maxsize(value)
  merge(gapmaxsize: value.to_s)
end
minsize(value) click to toggle source

Limit to pages with at least this many bytes.

@param value [Integer] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-allpages.rb, line 83
def minsize(value)
  merge(gapminsize: value.to_s)
end
namespace(value) click to toggle source

The namespace to enumerate.

@param value [String] One of “0”, “1”, “2”, “3”, “4”, “5”, “6”, “7”, “8”, “9”, “10”, “11”, “12”, “13”, “14”, “15”, “100”, “101”, “108”, “109”, “118”, “119”, “446”, “447”, “710”, “711”, “828”, “829”, “2300”, “2301”, “2302”, “2303”. @return [self]

# File lib/mediawiktory/wikipedia/modules/g-allpages.rb, line 57
def namespace(value)
  _namespace(value) or fail ArgumentError, "Unknown value for namespace: #{value}"
end
prefix(value) click to toggle source

Search for all page titles that begin with this value.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-allpages.rb, line 49
def prefix(value)
  merge(gapprefix: value.to_s)
end
prexpiry(value) click to toggle source

Which protection expiry to filter the page on:

@param value [String] One of “indefinite” (Get only pages with indefinite protection expiry), “definite” (Get only pages with a definite (specific) protection expiry), “all” (Get pages with any protections expiry). @return [self]

# File lib/mediawiktory/wikipedia/modules/g-allpages.rb, line 172
def prexpiry(value)
  _prexpiry(value) or fail ArgumentError, "Unknown value for prexpiry: #{value}"
end
prfiltercascade(value) click to toggle source

Filter protections based on cascadingness (ignored when apprtype isn't set).

@param value [String] One of “cascading”, “noncascading”, “all”. @return [self]

# File lib/mediawiktory/wikipedia/modules/g-allpages.rb, line 125
def prfiltercascade(value)
  _prfiltercascade(value) or fail ArgumentError, "Unknown value for prfiltercascade: #{value}"
end
prlevel(*values) click to toggle source

Filter protections based on protection level (must be used with apprtype= parameter).

@param values [Array<String>] Allowed values: “autoconfirmed”, “extendedconfirmed”, “templateeditor”, “sysop”. @return [self]

# File lib/mediawiktory/wikipedia/modules/g-allpages.rb, line 112
def prlevel(*values)
  values.inject(self) { |res, val| res._prlevel(val) or fail ArgumentError, "Unknown value for prlevel: #{val}" }
end
prtype(*values) click to toggle source

Limit to protected pages only.

@param values [Array<String>] Allowed values: “edit”, “move”, “upload”. @return [self]

# File lib/mediawiktory/wikipedia/modules/g-allpages.rb, line 99
def prtype(*values)
  values.inject(self) { |res, val| res._prtype(val) or fail ArgumentError, "Unknown value for prtype: #{val}" }
end
to(value) click to toggle source

The page title to stop enumerating at.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-allpages.rb, line 41
def to(value)
  merge(gapto: value.to_s)
end