Module: Twitter::Client::Notification

Included in:

Twitter::Client

Defined in:

lib/twitter/client/notification.rb

Overview

Defines methods related to notification

Instance Method Summary

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

  Disables notifications for updates from the specified user to the authenticating user.

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

  Enables device notifications for updates from the specified user to the authenticating user.

Instance Method Details

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

Disables notifications for updates from the specified user to the authenticating user

Examples:

Disable device notifications for updates from @sferik

Twitter.disable_notifications("sferik")
Twitter.disable_notifications(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 specified user.

Raises:

• (Twitter::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

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

Rate Limited?:

• No

Requires Authentication?:

• Yes

# File 'lib/twitter/client/notification.rb', line 41

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

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

Enables device notifications for updates from the specified user to the authenticating user

Examples:

Enable device notifications for updates from @sferik

Twitter.enable_notifications("sferik")
Twitter.enable_notifications(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 specified user.

Raises:

• (Twitter::Error::Unauthorized) —

  Error raised when supplied user credentials are not valid.

See Also:

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

Rate Limited?:

• No

Requires Authentication?:

• Yes

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

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