Module: MediaWiktory::Wikipedia::Modules::Userinfo

Defined in:

lib/mediawiktory/wikipedia/modules/userinfo.rb

Overview

Get information about the current user.

The "submodule" (MediaWiki API term) is included in action after setting some param, providing additional tweaking for this param. Example (for Actions::Query and its submodules):

api.query             # returns Actions::Query
   .prop(:revisions)  # adds prop=revisions to action URL, and includes Modules::Revisions into action
   .limit(10)         # method of Modules::Revisions, adds rvlimit=10 to URL

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

Instance Method Summary

• #attachedwiki(value) ⇒ self

  With uiprop=centralids, indicate whether the user is attached with the wiki identified by this ID.

• #prop(*values) ⇒ self

  Which pieces of information to include:.

Instance Method Details

#attachedwiki(value) ⇒ self

With uiprop=centralids, indicate whether the user is attached with the wiki identified by this ID.

Parameters:

• value (String)

Returns:

• (self)

# File 'lib/mediawiktory/wikipedia/modules/userinfo.rb', line 38

def attachedwiki(value)
  merge(uiattachedwiki: value.to_s)
end

#prop(*values) ⇒ self

Which pieces of information to include:

Parameters:

• values (Array<String>) —

  Allowed values: "blockinfo" (Tags if the current user is blocked, by whom, and for what reason), "hasmsg" (Adds a tag messages if the current user has pending messages), "groups" (Lists all the groups the current user belongs to), "groupmemberships" (Lists groups that the current user has been explicitly assigned to, including the expiry date of each group membership), "implicitgroups" (Lists all the groups the current user is automatically a member of), "rights" (Lists all the rights the current user has), "changeablegroups" (Lists the groups the current user can add to and remove from), "options" (Lists all preferences the current user has set), "preferencestoken" (Deprecated. Get a token to change current user's preferences), "editcount" (Adds the current user's edit count), "ratelimits" (Lists all rate limits applying to the current user), "email" (Adds the user's email address and email authentication date), "realname" (Adds the user's real name), "acceptlang" (Echoes the Accept-Language header sent by the client in a structured format), "registrationdate" (Adds the user's registration date), "unreadcount" (Adds the count of unread pages on the user's watchlist (maximum 999; returns 1000+ if more)), "centralids" (Adds the central IDs and attachment status for the user).

Returns:

• (self)

# File 'lib/mediawiktory/wikipedia/modules/userinfo.rb', line 25

def prop(*values)
  values.inject(self) { |res, val| res._prop(val) or fail ArgumentError, "Unknown value for prop: #{val}" }
end