Sha256: 95440f3195b455e6da093db2affe9a6fd4d958fbb547ae6fff1593ec2d3fa1c7

Contents?: true

Size: 1.29 KB

Versions: 4

Compression:

Stored size: 1.29 KB

Contents

# frozen_string_literal: true

module MediaWiktory::Wikipedia
  module Actions
    # Users with the 'transcode-reset' right can reset and re-run a transcode job.
    #
    # Usage:
    #
    # ```ruby
    # api.transcodereset.title(value).perform # returns string with raw output
    # # or
    # api.transcodereset.title(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.
    #
    class Transcodereset < MediaWiktory::Wikipedia::Actions::Post

      # The media file title.
      #
      # @param value [String]
      # @return [self]
      def title(value)
        merge(title: value.to_s)
      end

      # The transcode key you wish to reset. Fetch from action=query&prop=transcodestatus.
      #
      # @param value [String]
      # @return [self]
      def transcodekey(value)
        merge(transcodekey: value.to_s)
      end

      # A "csrf" token retrieved from action=query&meta=tokens
      #
      # @param value [String]
      # @return [self]
      def token(value)
        merge(token: value.to_s)
      end
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
mediawiktory-0.1.3 lib/mediawiktory/wikipedia/actions/transcodereset.rb
mediawiktory-0.1.2 lib/mediawiktory/wikipedia/actions/transcodereset.rb
mediawiktory-0.1.1 lib/mediawiktory/wikipedia/actions/transcodereset.rb
mediawiktory-0.1.0 lib/mediawiktory/wikipedia/actions/transcodereset.rb