Module: Twitter::Client::Block

Included in:

Twitter::Client

Defined in:

lib/twitter/client/block.rb

Overview

Defines methods related to blocking and unblocking users

See Also:

• SpamReporting

Instance Method Summary

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

  Blocks the user specified by the authenticating user.

• #block?(user, options = {}) ⇒ Boolean

  Returns true if the authenticating user is blocking a target user.

• #blocked_ids(options = {}) ⇒ Array

  Returns an array of numeric user ids the authenticating user is blocking.

• #blocking(options = {}) ⇒ Array<Twitter::User>

  Returns an array of user objects that the authenticating user is blocking.

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

  Un-blocks the user specified by the authenticating user.

Instance Method Details

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

Note:

Destroys a friendship to the blocked user if it exists.

Blocks the user specified by the authenticating user

Examples:

Block and unfriend @sferik as the authenticating user

Twitter.block("sferik")
Twitter.block(7505382)  # 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 blocked user.

Raises:

• (Twitter::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

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

Rate Limited?:

• Yes

Requires Authentication?:

• Yes

# File 'lib/twitter/client/block.rb', line 77

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

#block?(user, options = {}) ⇒ Boolean

Returns true if the authenticating user is blocking a target user

Examples:

Check whether the authenticating user is blocking @sferik

Twitter.block?("sferik")
Twitter.block?(7505382)  # Same as above

Parameters:

• user (Integer, String) —

  A Twitter user ID or screen name.

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

  A customizable set of options.

Returns:

• (Boolean) —

  true if the authenticating user is blocking the target user, otherwise false.

Raises:

• (Twitter::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://dev.twitter.com/docs/api/1/get/blocks/exists

Rate Limited?:

• Yes

Requires Authentication?:

• Yes

# File 'lib/twitter/client/block.rb', line 55

def block?(user, options={})
  options.merge_user!(user)
  get("/1/blocks/exists.json", options, :raw => true)
  true
rescue Twitter::Error::NotFound
  false
end

#blocked_ids(options = {}) ⇒ Array

Returns an array of numeric user ids the authenticating user is blocking

Examples:

Return an array of numeric user ids the authenticating user is blocking

Twitter.blocking_ids

Parameters:

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

  A customizable set of options.

Returns:

• (Array) —

  Numeric user ids the authenticating user is blocking.

Raises:

• (Twitter::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://dev.twitter.com/docs/api/1/get/blocks/blocking/ids

Rate Limited?:

• Yes

Requires Authentication?:

• Yes

# File 'lib/twitter/client/block.rb', line 39

def blocked_ids(options={})
  get("/1/blocks/blocking/ids.json", options)
end

#blocking(options = {}) ⇒ Array<Twitter::User>

Returns an array of user objects that the authenticating user is blocking

Examples:

Return an array of user objects that the authenticating user is blocking

Twitter.blocking

Parameters:

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

  A customizable set of options.

Options Hash (options):

• :page (Integer) —

  Specifies the page of results to retrieve.

• :include_entities (Boolean, String, Integer) —

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

Returns:

• (Array<Twitter::User>) —

  User objects that the authenticating user is blocking.

Raises:

• (Twitter::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

• https://dev.twitter.com/docs/api/1/get/blocks/blocking

Rate Limited?:

• Yes

Requires Authentication?:

• Yes

# File 'lib/twitter/client/block.rb', line 23

def blocking(options={})
  get("/1/blocks/blocking.json", options).map do |user|
    Twitter::User.new(user)
  end
end

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

Un-blocks the user specified by the authenticating user

Examples:

Un-block @sferik as the authenticating user

Twitter.unblock("sferik")
Twitter.unblock(7505382)  # 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 un-blocked user.

Raises:

• (Twitter::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

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

Rate Limited?:

• No

Requires Authentication?:

• Yes

# File 'lib/twitter/client/block.rb', line 96

def unblock(user, options={})
  options.merge_user!(user)
  user = delete("/1/blocks/destroy.json", options)
  Twitter::User.new(user)
end