Module: Twitter::API::SpamReporting

Includes:

Utils

Included in:

Client

Defined in:

lib/twitter/api/spam_reporting.rb

Constant Summary

Constants included from Utils

Utils::DEFAULT_CURSOR

Instance Method Summary

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

  The users specified are blocked by the authenticated user and reported as spammers.

Instance Method Details

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

The users specified are blocked by the authenticated user and reported as spammers

Overloads:

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

  Examples:

  Report @spam for spam

  Twitter.report_spam("spam")
  Twitter.report_spam(14589771) # Same as above
  

  Parameters:

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

    An array of Twitter user IDs, screen names, or objects.

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

  Parameters:

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

    An array 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/docs/api/1.1/post/users/report_spam

Authentication:

• Requires user context

Rate Limited?:

• Yes

# File 'lib/twitter/api/spam_reporting.rb', line 24

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