Class: MediaWiktory::Wikipedia::Actions::Cxpublish

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

Overview

Save a page created using the Content Translation extension.

Usage:

api.cxpublish.title(value).perform # returns string with raw output
# or
api.cxpublish.title(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

#categories(value) ⇒ self

The categories to put the published page in.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#from(value) ⇒ self

The source language code.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#html(value) ⇒ self

The content to save.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#sourcetitle(value) ⇒ self

The title of the source page.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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) 


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

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

#to(value) ⇒ self

The target language code.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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) 


90
91
92
 
# File 'lib/mediawiktory/wikipedia/actions/cxpublish.rb', line 90

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

#wpCaptchaId(value) ⇒ self

Captcha ID (when saving with a captcha response).

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#wpCaptchaWord(value) ⇒ self

Answer to the captcha (when saving with a captcha response).

Parameters:

  • value (String)

Returns:

  • (self) 


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

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