Module: MediaWiktory::Wikipedia::Modules::Cxpublishedtranslations

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

Overview

Fetch all published translations information.

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/cxpublishedtranslations.rb', line 25

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

#limit(value) ⇒ self

The maximum number of translations to fetch.

Parameters:

  • value (Integer, "max")

Returns:

  • (self) 


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

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

#offset(value) ⇒ self

When more results are available, use this to continue.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#to(value) ⇒ self

The target language code.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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