Contents

# frozen_string_literal: true

module Reality::Describers::Wikidata::Impl
  module Modules
    # Get a log of campaign configuration changes.
    #
    # The "submodule" (MediaWiki API term) is included in action after setting some param, providing
    # additional tweaking for this param. Example (for {Reality::Describers::Wikidata::Impl::Actions::Query} and
    # its submodules):
    #
    # ```ruby
    # 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.
    #
    module Centralnoticelogs

      # Campaign name (optional). Separate multiple values with a "|" (vertical bar).
      #
      # @param value [String]
      # @return [self]
      def campaign(value)
        merge(campaign: value.to_s)
      end

      # Username (optional).
      #
      # @param value [String]
      # @return [self]
      def user(value)
        merge(user: value.to_s)
      end

      # Maximum rows to return (optional).
      #
      # @param value [Integer, "max"]
      # @return [self]
      def limit(value)
        merge(limit: value.to_s)
      end

      # Offset into result set (optional).
      #
      # @param value [Integer]
      # @return [self]
      def offset(value)
        merge(offset: value.to_s)
      end

      # Start time of range (optional).
      #
      # @param value [Time]
      # @return [self]
      def start(value)
        merge(start: value.iso8601)
      end

      # End time of range (optional).
      #
      # @param value [Time]
      # @return [self]
      def end(value)
        merge(end: value.iso8601)
      end
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
reality-0.1.0.alpha3	lib/reality/describers/wikidata/modules/centralnoticelogs.rb
reality-0.1.0.alpha2	lib/reality/describers/wikidata/modules/centralnoticelogs.rb
reality-0.1.0.alpha	lib/reality/describers/wikidata/modules/centralnoticelogs.rb