Module: Twitter::REST::SpamReporting

Includes:

Utils

Included in:

API

Defined in:

lib/twitter/rest/spam_reporting.rb

Overview

Methods for reporting spam accounts

Constant Summary

Constants included from Utils

Utils::DEFAULT_CURSOR

Instance Method Summary

• #report_spam(*args) ⇒ Array<Twitter::User>

  Blocks users and reports them as spammers.

Methods included from Utils

flat_pmap, pmap

Instance Method Details

#report_spam(*users) ⇒ Array<Twitter::User> #report_spam(*users, options) ⇒ Array<Twitter::User>

Blocks users and reports them as spammers

Examples:

client.report_spam('spammer')

Overloads:

• #report_spam(*users) ⇒ Array<Twitter::User>

  Parameters:

  • users (Enumerable<Integer, String, Twitter::User>) —

    A collection of Twitter user IDs, screen names, or objects.

• #report_spam(*users, options) ⇒ Array<Twitter::User>

  Parameters:

  • users (Enumerable<Integer, String, Twitter::User>) —

    A collection of Twitter user IDs, screen names, or objects.

  • options (Hash) —

    A customizable set of options.

Returns:

• (Array<Twitter::User>) —

  The reported users.

Raises:

• (Twitter::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://dev.twitter.com/rest/reference/post/users/report_spam

# File 'lib/twitter/rest/spam_reporting.rb', line 25

def report_spam(*args)
  parallel_users_from_response(:post, "/1.1/users/report_spam.json", args)
end