module MediaWiktory::Wikipedia::Modules::Contenttranslationsuggestions

Get suggestion lists for Content Translation.

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

from(value) click to toggle source

The source language code.

@param value [String] @return [self]

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

The maximum number of translation suggestions to fetch.

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

# File lib/mediawiktory/wikipedia/modules/contenttranslationsuggestions.rb, line 49
def limit(value)
  merge(limit: value.to_s)
end
listid(value) click to toggle source

Return suggestions only from a particular list

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/contenttranslationsuggestions.rb, line 41
def listid(value)
  merge(listid: value.to_s)
end
offset(value) click to toggle source

Offset for paginated results.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/contenttranslationsuggestions.rb, line 57
def offset(value)
  merge(offset: value.to_s)
end
seed(value) click to toggle source

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.

@param value [Integer] @return [self]

# File lib/mediawiktory/wikipedia/modules/contenttranslationsuggestions.rb, line 65
def seed(value)
  merge(seed: value.to_s)
end
to(value) click to toggle source

The target language code.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/contenttranslationsuggestions.rb, line 33
def to(value)
  merge(to: value.to_s)
end