Module: Twitter::Client::SpamReporting

Included in:

Twitter::Client

Defined in:

lib/twitter/client/spam_reporting.rb

Overview

Defines methods related to spam reporting

See Also:

• Block

Instance Method Summary

• #report_spam(user, options = {}) ⇒ Twitter::User

  The user specified is blocked by the authenticated user and reported as a spammer.

Instance Method Details

#report_spam(user, options = {}) ⇒ Twitter::User

The user specified is blocked by the authenticated user and reported as a spammer

Examples:

Report @spam for spam

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

Parameters:

• user (Integer, String) —

  A Twitter user ID or screen name.

• options (Hash) (defaults to: {}) —

  A customizable set of options.

Options Hash (options):

• :include_entities (Boolean, String, Integer) —

  Include Tweet Entities when set to true, 't' or 1.

Returns:

• (Twitter::User) —

  The reported user.

See Also:

• https://dev.twitter.com/docs/api/1/post/report_spam

Rate Limited?:

• Yes

Requires Authentication?:

• No

# File 'lib/twitter/client/spam_reporting.rb', line 22

def report_spam(user, options={})
  options.merge_user!(user)
  user = post("/1/report_spam.json", options)
  Twitter::User.new(user)
end