Contents

require 'twitter/api/utils'
require 'twitter/user'

module Twitter
  module API
    module SpamReporting
      include Twitter::API::Utils

      # The users specified are blocked by the authenticated user and reported as spammers
      #
      # @see https://dev.twitter.com/docs/api/1.1/post/users/report_spam
      # @rate_limited Yes
      # @authentication_required Requires user context
      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
      # @return [Array<Twitter::User>] The reported users.
      # @overload report_spam(*users)
      #   @param users [Array<Integer, String, Twitter::User>, Set<Integer, String, Twitter::User>] An array of Twitter user IDs, screen names, or objects.
      #   @example Report @spam for spam
      #     Twitter.report_spam("spam")
      #     Twitter.report_spam(14589771) # Same as above
      # @overload report_spam(*users, options)
      #   @param users [Array<Integer, String, Twitter::User>, Set<Integer, String, Twitter::User>] An array of Twitter user IDs, screen names, or objects.
      #   @param options [Hash] A customizable set of options.
      def report_spam(*args)
        threaded_users_from_response(:post, "/1.1/users/report_spam.json", args)
      end

    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
twitter-4.4.2	lib/twitter/api/spam_reporting.rb
twitter-4.4.1	lib/twitter/api/spam_reporting.rb
twitter-4.4.0	lib/twitter/api/spam_reporting.rb