Class: MediaWiktory::Wikipedia::Actions::Cxsave

Inherits:
Post
  • Object
show all
Defined in:
lib/mediawiktory/wikipedia/actions/cxsave.rb

Overview

This module allows to save draft translations by section to save bandwidth and to collect parallel corpora.

Usage:

api.cxsave.from(value).perform # returns string with raw output
# or
api.cxsave.from(value).response # returns output parsed and wrapped into Response object

See Base for generic explanation of working with MediaWiki actions and Response for working with action responses.

All action's parameters are documented as its public methods, see below.

Instance Method Summary collapse

Methods inherited from Post

#perform

Methods inherited from Base

#inspect, #merge, #name, #perform, #response, #to_h, #to_param, #to_url

Methods included from GlobalParams

#assert, #assertuser, #centralauthtoken, #curtimestamp, #errorformat, #errorlang, #errorsuselocal, #format, #maxage, #maxlag, #origin, #requestid, #responselanginfo, #servedby, #smaxage, #uselang

Instance Method Details

#content(value) ⇒ self

JSON-encoded section data. Each section is an object and has the following keys: content, sectionId, sequenceId, sequenceId, origin

Parameters:

  • value (String)

Returns:

  • (self) 


58
59
60
 
# File 'lib/mediawiktory/wikipedia/actions/cxsave.rb', line 58

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

#from(value) ⇒ self

The source language code.

Parameters:

  • value (String)

Returns:

  • (self) 


26
27
28
 
# File 'lib/mediawiktory/wikipedia/actions/cxsave.rb', line 26

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

#progress(value) ⇒ self

Information about translation completion (progress). JSON with the keys any, human, mt and mtSectionsCount. The keys' values are percentages.

Parameters:

  • value (String)

Returns:

  • (self) 


74
75
76
 
# File 'lib/mediawiktory/wikipedia/actions/cxsave.rb', line 74

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

#sourcerevision(value) ⇒ self

The revision of the source page.

Parameters:

  • value (Integer)

Returns:

  • (self) 


66
67
68
 
# File 'lib/mediawiktory/wikipedia/actions/cxsave.rb', line 66

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

#sourcetitle(value) ⇒ self

The title of the source page.

Parameters:

  • value (String)

Returns:

  • (self) 


42
43
44
 
# File 'lib/mediawiktory/wikipedia/actions/cxsave.rb', line 42

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

#title(value) ⇒ self

The title of the page to perform actions on.

Parameters:

  • value (String)

Returns:

  • (self) 


50
51
52
 
# File 'lib/mediawiktory/wikipedia/actions/cxsave.rb', line 50

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

#to(value) ⇒ self

The target language code.

Parameters:

  • value (String)

Returns:

  • (self) 


34
35
36
 
# File 'lib/mediawiktory/wikipedia/actions/cxsave.rb', line 34

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

#token(value) ⇒ self

A "csrf" token retrieved from action=query&meta=tokens

Parameters:

  • value (String)

Returns:

  • (self) 


82
83
84
 
# File 'lib/mediawiktory/wikipedia/actions/cxsave.rb', line 82

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