Class: MediaWiktory::Wikipedia::Actions::Addstudents

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

Overview

Add multiple students to a course.

Usage:

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

#courseid(value) ⇒ self

The ID of the course to which the students should be added/removed.

Parameters:

  • value (Integer)

Returns:

  • (self) 


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

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

#studentusernames(*values) ⇒ self

The usernames of the students to add to the course.

Parameters:

  • values (Array<String>)

Returns:

  • (self) 


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

def studentusernames(*values)
  values.inject(self) { |res, val| res._studentusernames(val) }
end

#token(value) ⇒ self

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

Parameters:

  • value (String)

Returns:

  • (self) 


47
48
49
 
# File 'lib/mediawiktory/wikipedia/actions/addstudents.rb', line 47

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