Class: MediaWiktory::Wikipedia::Actions::Deleteeducation

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

Overview

Delete Education Program objects.

Usage:

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

#comment(value) ⇒ self

Reason for this deletion, for the log.

Parameters:

  • value (String)

Returns:

  • (self) 


52
53
54
 
# File 'lib/mediawiktory/wikipedia/actions/deleteeducation.rb', line 52

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

#ids(*values) ⇒ self

The IDs of the objects to delete.

Parameters:

  • values (Array<Integer>)

Returns:

  • (self) 


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

def ids(*values)
  values.inject(self) { |res, val| res._ids(val) }
end

#token(value) ⇒ self

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

Parameters:

  • value (String)

Returns:

  • (self) 


60
61
62
 
# File 'lib/mediawiktory/wikipedia/actions/deleteeducation.rb', line 60

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

#type(value) ⇒ self

Type of object to delete.

Parameters:

  • value (String) —

    One of "org", "course".

Returns:

  • (self) 


39
40
41
 
# File 'lib/mediawiktory/wikipedia/actions/deleteeducation.rb', line 39

def type(value)
  _type(value) or fail ArgumentError, "Unknown value for type: #{value}"
end