Class: MediaWiktory::Wikipedia::Actions::Setglobalaccountstatus

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

Overview

Set a global user's status.

Usage:

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

#hidden(value) ⇒ self

Change whether this user is not hidden, hidden from lists, or suppressed.

Parameters:

  • value (String) —

    One of "lists", "suppressed".

Returns:

  • (self) 


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

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

#locked(value) ⇒ self

Change whether this user is locked or not.

Parameters:

  • value (String) —

    One of "lock", "unlock".

Returns:

  • (self) 


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

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

#reason(value) ⇒ self

Reason for changing the user's status.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#statecheck(value) ⇒ self

Optional MD5 of the expected current ::, to detect edit conflicts. Set to 1 for locked, 0 for unlocked.

Parameters:

  • value (String)

Returns:

  • (self) 


68
69
70
 
# File 'lib/mediawiktory/wikipedia/actions/setglobalaccountstatus.rb', line 68

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

#token(value) ⇒ self

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

Parameters:

  • value (String)

Returns:

  • (self) 


76
77
78
 
# File 'lib/mediawiktory/wikipedia/actions/setglobalaccountstatus.rb', line 76

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

#user(value) ⇒ self

User to change the status of.

Parameters:

  • value (String)

Returns:

  • (self) 


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

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