module MediaWiktory::Wikipedia::Modules::GCategorymembers

List all pages in a given category. _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-categorymembers.rb, line 101
def _dir(value)
  defined?(super) && super || ["asc", "desc", "ascending", "descending", "newer", "older"].include?(value.to_s) && merge(gcmdir: value.to_s)
end
_namespace(value) click to toggle source

@private

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

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/g-categorymembers.rb, line 88
def _sort(value)
  defined?(super) && super || ["sortkey", "timestamp"].include?(value.to_s) && merge(gcmsort: value.to_s)
end
_type(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/g-categorymembers.rb, line 59
def _type(value)
  defined?(super) && super || ["page", "subcat", "file"].include?(value.to_s) && merge(gcmtype: 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-categorymembers.rb, line 67
def continue(value)
  merge(gcmcontinue: value.to_s)
end
dir(value) click to toggle source

In which direction to sort.

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

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

Timestamp to end listing at. Can only be used with cmsort=timestamp.

@param value [Time] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-categorymembers.rb, line 117
def end(value)
  merge(gcmend: value.iso8601)
end
endhexsortkey(value) click to toggle source

Sortkey to end listing at, as returned by cmprop=sortkey. Can only be used with cmsort=sortkey.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-categorymembers.rb, line 133
def endhexsortkey(value)
  merge(gcmendhexsortkey: value.to_s)
end
endsortkey(value) click to toggle source

Use cmendhexsortkey instead.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-categorymembers.rb, line 165
def endsortkey(value)
  merge(gcmendsortkey: value.to_s)
end
endsortkeyprefix(value) click to toggle source

Sortkey prefix to end listing before (not at; if this value occurs it will not be included!). Can only be used with cmsort=sortkey. Overrides cmendhexsortkey.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-categorymembers.rb, line 149
def endsortkeyprefix(value)
  merge(gcmendsortkeyprefix: value.to_s)
end
limit(value) click to toggle source

The maximum number of pages to return.

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

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

Only include pages in these namespaces. Note that cmtype=subcat or cmtype=file may be used instead of cmnamespace=14 or 6.

@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-categorymembers.rb, line 41
def namespace(*values)
  values.inject(self) { |res, val| res._namespace(val) or fail ArgumentError, "Unknown value for namespace: #{val}" }
end
pageid(value) click to toggle source

Page ID of the category to enumerate. Cannot be used together with cmtitle.

@param value [Integer] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-categorymembers.rb, line 33
def pageid(value)
  merge(gcmpageid: value.to_s)
end
sort(value) click to toggle source

Property to sort by.

@param value [String] One of “sortkey”, “timestamp”. @return [self]

# File lib/mediawiktory/wikipedia/modules/g-categorymembers.rb, line 83
def sort(value)
  _sort(value) or fail ArgumentError, "Unknown value for sort: #{value}"
end
start(value) click to toggle source

Timestamp to start listing from. Can only be used with cmsort=timestamp.

@param value [Time] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-categorymembers.rb, line 109
def start(value)
  merge(gcmstart: value.iso8601)
end
starthexsortkey(value) click to toggle source

Sortkey to start listing from, as returned by cmprop=sortkey. Can only be used with cmsort=sortkey.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-categorymembers.rb, line 125
def starthexsortkey(value)
  merge(gcmstarthexsortkey: value.to_s)
end
startsortkey(value) click to toggle source

Use cmstarthexsortkey instead.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-categorymembers.rb, line 157
def startsortkey(value)
  merge(gcmstartsortkey: value.to_s)
end
startsortkeyprefix(value) click to toggle source

Sortkey prefix to start listing from. Can only be used with cmsort=sortkey. Overrides cmstarthexsortkey.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-categorymembers.rb, line 141
def startsortkeyprefix(value)
  merge(gcmstartsortkeyprefix: value.to_s)
end
title(value) click to toggle source

Which category to enumerate (required). Must include the Category: prefix. Cannot be used together with cmpageid.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/g-categorymembers.rb, line 25
def title(value)
  merge(gcmtitle: value.to_s)
end
type(*values) click to toggle source

Which type of category members to include. Ignored when cmsort=timestamp is set.

@param values [Array<String>] Allowed values: “page”, “subcat”, “file”. @return [self]

# File lib/mediawiktory/wikipedia/modules/g-categorymembers.rb, line 54
def type(*values)
  values.inject(self) { |res, val| res._type(val) or fail ArgumentError, "Unknown value for type: #{val}" }
end