class MediaWiktory::Wikipedia::Actions::Addstudents

Add multiple students to a course.

Usage:

“`ruby 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 {MediaWiktory::Wikipedia::Response} for working with action responses.

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

Public Instance Methods

_studentusernames(value) click to toggle source

@private

# File lib/mediawiktory/wikipedia/actions/addstudents.rb, line 31
def _studentusernames(value)
  merge(studentusernames: value.to_s, replace: false)
end
courseid(value) click to toggle source

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

@param value [Integer] @return [self]

# File lib/mediawiktory/wikipedia/actions/addstudents.rb, line 39
def courseid(value)
  merge(courseid: value.to_s)
end
studentusernames(*values) click to toggle source

The usernames of the students to add to the course.

@param values [Array<String>] @return [self]

# File lib/mediawiktory/wikipedia/actions/addstudents.rb, line 26
def studentusernames(*values)
  values.inject(self) { |res, val| res._studentusernames(val) }
end
token(value) click to toggle source

A “csrf” token retrieved from action=query&meta=tokens

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/actions/addstudents.rb, line 47
def token(value)
  merge(token: value.to_s)
end