Module: MediaWiktory::Wikipedia::Modules::GContenttranslationsuggestions

Defined in:
lib/mediawiktory/wikipedia/modules/g-contenttranslationsuggestions.rb

Overview

Get suggestion lists for Content Translation. 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 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

#from(value) ⇒ self

The source language code.

Parameters:

  • value (String)

Returns:

  • (self) 


25
26
27
 
# File 'lib/mediawiktory/wikipedia/modules/g-contenttranslationsuggestions.rb', line 25

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

#limit(value) ⇒ self

The maximum number of translation suggestions to fetch.

Parameters:

  • value (Integer, "max")

Returns:

  • (self) 


49
50
51
 
# File 'lib/mediawiktory/wikipedia/modules/g-contenttranslationsuggestions.rb', line 49

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

#listid(value) ⇒ self

Return suggestions only from a particular list

Parameters:

  • value (String)

Returns:

  • (self) 


41
42
43
 
# File 'lib/mediawiktory/wikipedia/modules/g-contenttranslationsuggestions.rb', line 41

def listid(value)
  merge(glistid: value.to_s)
end

#offset(value) ⇒ self

Offset for paginated results.

Parameters:

  • value (String)

Returns:

  • (self) 


57
58
59
 
# File 'lib/mediawiktory/wikipedia/modules/g-contenttranslationsuggestions.rb', line 57

def offset(value)
  merge(goffset: value.to_s)
end

#seed(value) ⇒ self

By default suggestions are returned in random order. If you wish to return each suggestion only once when using limit and offset, you must specify a seed for all the requests.

Parameters:

  • value (Integer)

Returns:

  • (self) 


65
66
67
 
# File 'lib/mediawiktory/wikipedia/modules/g-contenttranslationsuggestions.rb', line 65

def seed(value)
  merge(gseed: value.to_s)
end

#to(value) ⇒ self

The target language code.

Parameters:

  • value (String)

Returns:

  • (self) 


33
34
35
 
# File 'lib/mediawiktory/wikipedia/modules/g-contenttranslationsuggestions.rb', line 33

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