Module: MediaWiktory::Wikipedia::Modules::Allredirects

Defined in:
lib/mediawiktory/wikipedia/modules/allredirects.rb

Overview

List all redirects to a namespace.

The "submodule" (MediaWiki API term) is included in action after setting some param, providing additional tweaking for this param. Example (for Actions::Query and its submodules):

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.

Instance Method Summary collapse

Instance Method Details

#continue(value) ⇒ self

When more results are available, use this to continue.

Parameters:

  • value (String)

Returns:

  • (self) 


25
26
27
 
# File 'lib/mediawiktory/wikipedia/modules/allredirects.rb', line 25

def continue(value)
  merge(arcontinue: value.to_s)
end

#dir(value) ⇒ self

The direction in which to list.

Parameters:

  • value (String) —

    One of "ascending", "descending".

Returns:

  • (self) 


98
99
100
 
# File 'lib/mediawiktory/wikipedia/modules/allredirects.rb', line 98

def dir(value)
  _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}"
end

#from(value) ⇒ self

The title of the redirect to start enumerating from.

Parameters:

  • value (String)

Returns:

  • (self) 


33
34
35
 
# File 'lib/mediawiktory/wikipedia/modules/allredirects.rb', line 33

def from(value)
  merge(arfrom: value.to_s)
end

#limit(value) ⇒ self

How many total items to return.

Parameters:

  • value (Integer, "max")

Returns:

  • (self) 


90
91
92
 
# File 'lib/mediawiktory/wikipedia/modules/allredirects.rb', line 90

def limit(value)
  merge(arlimit: value.to_s)
end

#namespace(value) ⇒ self

The namespace to enumerate.

Parameters:

  • value (String) —

    One of "-2", "-1", "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".

Returns:

  • (self) 


77
78
79
 
# File 'lib/mediawiktory/wikipedia/modules/allredirects.rb', line 77

def namespace(value)
  _namespace(value) or fail ArgumentError, "Unknown value for namespace: #{value}"
end

#prefix(value) ⇒ self

Search for all target pages that begin with this value.

Parameters:

  • value (String)

Returns:

  • (self) 


49
50
51
 
# File 'lib/mediawiktory/wikipedia/modules/allredirects.rb', line 49

def prefix(value)
  merge(arprefix: value.to_s)
end

#prop(*values) ⇒ self

Which pieces of information to include:

Parameters:

  • values (Array<String>) —

    Allowed values: "ids" (Adds the page ID of the redirecting page (cannot be used with arunique)), "title" (Adds the title of the redirect), "fragment" (Adds the fragment from the redirect, if any (cannot be used with arunique)), "interwiki" (Adds the interwiki prefix from the redirect, if any (cannot be used with arunique)).

Returns:

  • (self) 


64
65
66
 
# File 'lib/mediawiktory/wikipedia/modules/allredirects.rb', line 64

def prop(*values)
  values.inject(self) { |res, val| res._prop(val) or fail ArgumentError, "Unknown value for prop: #{val}" }
end

#to(value) ⇒ self

The title of the redirect to stop enumerating at.

Parameters:

  • value (String)

Returns:

  • (self) 


41
42
43
 
# File 'lib/mediawiktory/wikipedia/modules/allredirects.rb', line 41

def to(value)
  merge(arto: value.to_s)
end

#unique ⇒ self

Only show distinct target pages. Cannot be used with arprop=ids|fragment|interwiki. When used as a generator, yields target pages instead of source pages.

Returns:

  • (self) 


56
57
58
 
# File 'lib/mediawiktory/wikipedia/modules/allredirects.rb', line 56

def unique()
  merge(arunique: 'true')
end