Module: Twitter::API::Undocumented

### Home Classes Methods

### In Files

- lib/twitter/api/undocumented.rb

### Methods

- #activity_about_me
- #activity_by_friends
- #following_followers_of
- #status_activity
- #statuses_activity
- #tweet_activity

### Included Modules

- Twitter::API::Utils

### Class/Module Index

Quicksearch

- Twitter
- Twitter::API
- Twitter::API::Arguments
- Twitter::API::DirectMessages
- Twitter::API::Favorites
- Twitter::API::FriendsAndFollowers
- Twitter::API::Help
- Twitter::API::Lists
- Twitter::API::PlacesAndGeo
- Twitter::API::SavedSearches
- Twitter::API::Search
- Twitter::API::SpamReporting
- Twitter::API::SuggestedUsers
- Twitter::API::Timelines
- Twitter::API::Trends
- Twitter::API::Tweets
- Twitter::API::Undocumented
- Twitter::API::Users
- Twitter::API::Utils
- Twitter::Action
- Twitter::Action::Favorite
- Twitter::Action::Follow
- Twitter::Action::ListMemberAdded
- Twitter::Action::Mention
- Twitter::Action::Reply
- Twitter::Action::Retweet
- Twitter::Action::Status
- Twitter::Action::Tweet
- Twitter::ActionFactory
- Twitter::Base
- Twitter::BasicUser
- Twitter::Client
- Twitter::Configurable
- Twitter::Configuration
- Twitter::Creatable
- Twitter::Cursor
- Twitter::Default
- Twitter::DirectMessage
- Twitter::Entity
- Twitter::Entity::Hashtag
- Twitter::Entity::Url
- Twitter::Entity::UserMention
- Twitter::Error
- Twitter::Error::AlreadyFavorited
- Twitter::Error::AlreadyRetweeted
- Twitter::Error::BadGateway
- Twitter::Error::BadRequest
- Twitter::Error::ClientError
- Twitter::Error::ConfigurationError
- Twitter::Error::DecodeError
- Twitter::Error::EnhanceYourCalm
- Twitter::Error::Forbidden
- Twitter::Error::GatewayTimeout
- Twitter::Error::IdentityMapKeyError
- Twitter::Error::InternalServerError
- Twitter::Error::NotAcceptable
- Twitter::Error::NotFound
- Twitter::Error::RateLimited
- Twitter::Error::ServerError
- Twitter::Error::ServiceUnavailable
- Twitter::Error::TooManyRequests
- Twitter::Error::Unauthorized
- Twitter::Error::UnprocessableEntity
- Twitter::Exceptable
- Twitter::Factory
- Twitter::Geo
- Twitter::Geo::Point
- Twitter::Geo::Polygon
- Twitter::GeoFactory
- Twitter::Identity
- Twitter::IdentityMap
- Twitter::Language
- Twitter::List
- Twitter::Media
- Twitter::Media::Photo
- Twitter::MediaFactory
- Twitter::Metadata
- Twitter::OEmbed
- Twitter::Place
- Twitter::ProfileBanner
- Twitter::RateLimit
- Twitter::Relationship
- Twitter::Request
- Twitter::Request::MultipartWithFile
- Twitter::Response
- Twitter::Response::ParseJson
- Twitter::Response::RaiseError
- Twitter::SavedSearch
- Twitter::SearchResults
- Twitter::Settings
- Twitter::Size
- Twitter::SourceUser
- Twitter::Status
- Twitter::Suggestion
- Twitter::TargetUser
- Twitter::Trend
- Twitter::Tweet
- Twitter::User
- Twitter::Version
- Enumerable
- Kernel

No matching classes.

# Twitter::API::Undocumented

### Public Instance Methods

activity_about_me(options={}) click to toggle source

Returns activity about me

@note Undocumented @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Array] An array of actions @param options [Hash] A customizable set of options. @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 100. @option options [Integer] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID. @example Return activity about me

    Twitter.activity_about_me

    # File lib/twitter/api/undocumented.rb, line 25
    def activity_about_me(options={})
      objects_from_response(Twitter::ActionFactory, :get, "/i/activity/about_me.json", options)
    end

activity_by_friends(options={}) click to toggle source

Returns activity by friends

@note Undocumented @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid./ @return [Array] An array of actions @param options [Hash] A customizable set of options. @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 100. @option options [Integer] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID. @example Return activity by friends

    Twitter.activity_by_friends

    # File lib/twitter/api/undocumented.rb, line 41
    def activity_by_friends(options={})
      objects_from_response(Twitter::ActionFactory, :get, "/i/activity/by_friends.json", options)
    end

following_followers_of(*args) click to toggle source

@note Undocumented @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.

@overload following_followers_of(options={})

    Returns users following followers of the specified user

    @param options [Hash] A customizable set of options.
      @option options [Integer] :cursor (-1) Breaks the results into pages. Provide values as returned in the response objects's next_cursor and previous_cursor attributes to page back and forth in the list.
      @return [Twitter::Cursor]
    @example Return users follow followers of @sferik
      Twitter.following_followers_of

@overload following_followers_of(user, options={})

    Returns users following followers of the authenticated user

    @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, or object.
    @param options [Hash] A customizable set of options.
      @option options [Integer] :cursor (-1) Breaks the results into pages. Provide values as returned in the response objects's next_cursor and previous_cursor attributes to page back and forth in the list.
      @return [Twitter::Cursor]
    @example Return users follow followers of @sferik
      Twitter.following_followers_of('sferik')
      Twitter.following_followers_of(7505382)  # Same as above

    # File lib/twitter/api/undocumented.rb, line 69
    def following_followers_of(*args)
      cursor_from_response_with_user(:users, Twitter::User, :get, "/users/following_followers_of.json", args, :following_followers_of)
    end

status_activity(id, options={}) click to toggle source

Returns activity summary for a Tweet

@note Undocumented @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Twitter::Tweet] The requested Tweet. @param id [Integer] A Tweet ID. @param options [Hash] A customizable set of options. @example Return activity summary for the Tweet with the ID 25938088801

    Twitter.status_activity(25938088801)

    # File lib/twitter/api/undocumented.rb, line 84
    def status_activity(id, options={})
      response = get("/i/statuses/#{id}/activity/summary.json", options)
      response[:body].merge!(:id => id) if response[:body]
      Twitter::Tweet.from_response(response)
    end

Also aliased as: tweet_activity
statuses_activity(*args) click to toggle source

Returns activity summary for Tweets

@note Undocumented @rate_limited Yes @authentication Requires user context @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid. @return [Array<Twitter::Tweet>] The requested Tweets. @overload statuses_activity(*ids)

    @param ids [Array<Integer>, Set<Integer>] An array of Tweet IDs.
    @example Return activity summary for the Tweet with the ID 25938088801
      Twitter.statuses_activity(25938088801)

@overload statuses_activity(*ids, options)

    @param ids [Array<Integer>, Set<Integer>] An array of Tweet IDs.
    @param options [Hash] A customizable set of options.

    # File lib/twitter/api/undocumented.rb, line 105
    def statuses_activity(*args)
      arguments = Twitter::API::Arguments.new(args)
      arguments.flatten.threaded_map do |id|
        status_activity(id, arguments.options)
      end
    end

tweet_activity(id, options={}) click to toggle source
Alias for: status_activity

[Validate]

Generated with the Darkfish Rdoc Generator 2.