### Home Classes Methods

### In Files

- lib/github_api/users.rb

### Parent

API

### Namespace

- CLASS Github::Users::Emails
- CLASS Github::Users::Followers
- CLASS Github::Users::Keys

### Methods

- #all
- #emails
- #find
- #followers
- #get
- #keys
- #list
- #update

### 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

### Public Instance Methods

all(*args) click to toggle source
Alias for: list
emails(options={}, &block) click to toggle source

Access to Users::Emails API

    # File lib/github_api/users.rb, line 23
    def emails(options={}, &block)
      @emails ||= ApiFactory.new('Users::Emails', current_options.merge(options), &block)
    end

find(*args) click to toggle source
Alias for: get
followers(options={}, &block) click to toggle source

Access to Users::Followers API

    # File lib/github_api/users.rb, line 28
    def followers(options={}, &block)
      @followers ||= ApiFactory.new('Users::Followers', current_options.merge(options), &block)
    end

get(*args) click to toggle source

Get a single unauthenticated user

# Examples

    github = Github.new
    github.users.get user: 'user-name'

Get the authenticated user

# Examples

    github = Github.new oauth_token: '...'
    github.users.get

    # File lib/github_api/users.rb, line 70
    def get(*args)
      params = arguments(args).params

      if user_name = params.delete('user')
        get_request("/users/#{user_name}", params)
      else
        get_request("/user", params)
      end
    end

Also aliased as: find
keys(options={}, &block) click to toggle source

Access to Users::Keys API

    # File lib/github_api/users.rb, line 33
    def keys(options={}, &block)
      @keys ||= ApiFactory.new('Users::Keys', current_options.merge(options), &block)
    end

list(*args) click to toggle source

List all users.

This provides a dump of every user, in the order that they signed up for GitHub.

# Parameters

- `:since` - The integer ID of the last User that you’ve seen.

# Examples

    users = Github::Users.new
    users.list

    # File lib/github_api/users.rb, line 49
    def list(*args)
      arguments(args)

      response = get_request("/users", arguments.params)
      return response unless block_given?
      response.each { |el| yield el }
    end

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

Update the authenticated user

# Inputs

- `:name` - Optional string

- `:email` - Optional string - publically visible email address

- `:blog` - Optional string

- `:company` - Optional string

- `:location` - Optional string

- `:hireable` - Optional boolean

- `:bio` - Optional string

# Examples

    github = Github.new :oauth_token => '..'
    github.users.update
      "name" => "monalisa octocat",
      "email" => "octocat@github.com",
      "blog" => "https://github.com/blog",
      "company" => "GitHub",
      "location" => "San Francisco",
      "hireable" => true,
      "bio" => "There once..."

    # File lib/github_api/users.rb, line 103
    def update(*args)
      arguments(args) do
        sift VALID_USER_PARAMS_NAMES
      end

      patch_request("/user", arguments.params)
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.