Class: MediaWiktory::Wikipedia::Actions::Echomarkseen

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

Overview

Mark notifications as seen for the current user.

Usage:

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

#timestampFormat(value) ⇒ self

Timestamp format to use for output, 'ISO_8601' or 'MW'. 'MW' is deprecated here, so all clients should switch to 'ISO_8601'. This parameter will be removed, and 'ISO_8601' will become the only output format.

Parameters:

  • value (String) —

    One of "ISO_8601", "MW".

Returns:

  • (self) 


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

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

#token(value) ⇒ self

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

Parameters:

  • value (String)

Returns:

  • (self) 


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

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

#type(value) ⇒ self

Type of notifications to mark as seen: 'alert', 'message' or 'all'.

Parameters:

  • value (String) —

    One of "alert", "message", "all".

Returns:

  • (self) 


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

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