### Home Classes Methods

### In Files

- lib/github_api/users/followers.rb

### Parent

Github::API

### Methods

- #all
- #follow
- #following
- #following?
- #list
- #unfollow

### Class/Module Index

Quicksearch

- Github
- Github::API
- Github::Activity
- Github::Activity::Events
- Github::Activity::Notifications
- Github::Activity::Starring
- Github::Activity::Watching
- Github::ApiFactory
- Github::Arguments
- Github::Authorization
- Github::Authorizations
- Github::AutoloadHelper
- Github::Client
- Github::Configuration
- Github::Connection
- Github::Constants
- Github::CoreExt
- Github::CoreExt::OrderedHash
- Github::Descendants
- Github::Emojis
- Github::Error
- Github::Error::BadRequest
- Github::Error::ClientError
- Github::Error::Forbidden
- Github::Error::GithubError
- Github::Error::InternalServerError
- Github::Error::InvalidOptions
- Github::Error::NotAcceptable
- Github::Error::NotFound
- Github::Error::RequiredParams
- Github::Error::ServiceError
- Github::Error::ServiceUnavailable
- Github::Error::Unauthorized
- Github::Error::UnknownValue
- Github::Error::UnprocessableEntity
- Github::Error::Validations
- Github::Gists
- Github::Gists::Comments
- Github::GitData
- Github::GitData::Blobs
- Github::GitData::Commits
- Github::GitData::References
- Github::GitData::Tags
- Github::GitData::Trees
- Github::Gitignore
- Github::Issues
- Github::Issues::Assignees
- Github::Issues::Comments
- Github::Issues::Events
- Github::Issues::Labels
- Github::Issues::Milestones
- Github::Jsonable
- Github::Markdown
- Github::Meta
- Github::MimeType
- Github::Normalizer
- Github::Orgs
- Github::Orgs::Members
- Github::Orgs::Teams
- Github::PageIterator
- Github::PageLinks
- Github::PagedRequest
- Github::Pagination
- Github::ParameterFilter
- Github::ParamsHash
- Github::PullRequests
- Github::PullRequests::Comments
- Github::RateLimit
- Github::Repos
- Github::Repos::Collaborators
- Github::Repos::Comments
- Github::Repos::Commits
- Github::Repos::Contents
- Github::Repos::Downloads
- Github::Repos::Forks
- Github::Repos::Hooks
- Github::Repos::Keys
- Github::Repos::Merging
- Github::Repos::PubSubHubbub
- Github::Repos::Statistics
- Github::Repos::Statuses
- Github::Request
- Github::Request::BasicAuth
- Github::Request::Jsonize
- Github::Request::OAuth2
- Github::Resource
- Github::Response
- Github::Response::Header
- Github::Response::Jsonize
- Github::Response::Mashify
- Github::Response::RaiseError
- Github::Response::Xmlize
- Github::ResponseWrapper
- Github::S3Uploader
- Github::Say
- Github::Scopes
- Github::Search
- Github::Users
- Github::Users::Emails
- Github::Users::Followers
- Github::Users::Keys
- Github::Utils
- Github::Utils::Url
- Github::VERSION
- Github::Validations
- Github::Validations::Format
- Github::Validations::Presence
- Github::Validations::Required
- Github::Validations::Token
- Hash

No matching classes.

# Github::Users::Followers

### Public Instance Methods

all(*args) click to toggle source
Alias for: list
follow(*args) click to toggle source

Follow a user

# Examples

    github = Github.new oauth_token: '...'
    github.users.followers.follow 'user-name'
    github.users.followers.follow user: 'user-name'

    # File lib/github_api/users/followers.rb, line 80
    def follow(*args)
      arguments(args, :required => [:user])
      put_request("/user/following/#{user}", arguments.params)
    end

following(*args) click to toggle source

List who a user is following

# Examples

    github = Github.new
    github.users.followers.following 'user-name'
    github.users.followers.following 'user-name' { |user| ... }

List who the authenicated user is following

# Examples

    github = Github.new oauth_token: '...'
    github.users.followers.following

    # File lib/github_api/users/followers.rb, line 46
    def following(*args)
      params = arguments(args).params

      response = if user_name = arguments.remaining.first
        get_request("/users/#{user_name}/following", params)
      else
        get_request("/user/following", params)
      end
      return response unless block_given?
      response.each { |el| yield el }
    end

following?(*args) click to toggle source

Check if you are following a user

# Examples

    github = Github.new oauth_token: '...'
    github.users.followers.following? 'user-name'
    github.users.followers.following? user: 'user-name'

    # File lib/github_api/users/followers.rb, line 65
    def following?(*args)
      arguments(args, :required => [:user])
      get_request("/user/following/#{user}", arguments.params)
      true
    rescue Github::Error::NotFound
      false
    end

list(*args) click to toggle source

List a user's followers

# Examples

    github = Github.new
    github.users.followers.list 'user-name'
    github.users.followers.list 'user-name' { |user| ... }

List the authenticated user's followers

# Examples

    github = Github.new oauth_token: '...'
    github.users.followers
    github.users.followers { |user| ... }

    # File lib/github_api/users/followers.rb, line 19
    def list(*args)
      params = arguments(args).params

      response = if user_name = arguments.remaining.first
        get_request("/users/#{user_name}/followers", params)
      else
        get_request("/user/followers", params)
      end
      return response unless block_given?
      response.each { |el| yield el }
    end

Also aliased as: all
unfollow(*args) click to toggle source

Unfollow a user

# Examples

    github = Github.new oauth_token: '...'
    github.users.followers.unfollow 'user-name'
    github.users.followers.unfollow user: 'user-name'

    # File lib/github_api/users/followers.rb, line 92
    def unfollow(*args)
      arguments(args, :required => [:user])
      delete_request("/user/following/#{user}", arguments.params)
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.