module MediaWiktory::Wikipedia::Modules::GPrefixsearch

Perform a prefix search for page titles. _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

_namespace(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/g-prefixsearch.rb, line 38
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(gpsnamespace: value.to_s, replace: false)
end
_profile(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/g-prefixsearch.rb, line 67
def _profile(value)
  defined?(super) && super || ["strict", "normal", "fuzzy", "fast-fuzzy", "classic"].include?(value.to_s) && merge(gpsprofile: value.to_s)
end
limit(value) click to toggle source

Maximum number of results to return.

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

# File lib/mediawiktory/wikipedia/modules/g-prefixsearch.rb, line 46
def limit(value)
  merge(gpslimit: value.to_s)
end
namespace(*values) click to toggle source

Namespaces to search.

@param values [Array<String>] Allowed values: “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-prefixsearch.rb, line 33
def namespace(*values)
  values.inject(self) { |res, val| res._namespace(val) or fail ArgumentError, "Unknown value for namespace: #{val}" }
end
offset(value) click to toggle source

When more results are available, use this to continue.

@param value [Integer] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-prefixsearch.rb, line 54
def offset(value)
  merge(gpsoffset: value.to_s)
end
profile(value) click to toggle source

Search profile to use.

@param value [String] One of “strict” (Strict profile with few punctuation characters removed but diacritics and stress marks are kept), “normal” (Few punctuation characters, some diacritics and stopwords removed), “fuzzy” (Similar to normal with typo correction (two typos supported)), “fast-fuzzy” (Experimental fuzzy profile (may be removed at any time)), “classic” (Classic prefix, few punctuation characters and some diacritics removed). @return [self]

# File lib/mediawiktory/wikipedia/modules/g-prefixsearch.rb, line 62
def profile(value)
  _profile(value) or fail ArgumentError, "Unknown value for profile: #{value}"
end