### Home Classes Methods

### In Files

- lib/github_api/client.rb

### Parent

API

### Methods

- #activity
- #authorizations
- #emojis
- #gists
- #git
- #git_data
- #git_ignore
- #gitignore
- #issues
- #markdown
- #meta
- #oauth
- #octocat
- #organizations
- #orgs
- #pull_requests
- #pulls
- #repos
- #repositories
- #scopes
- #search
- #users

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

### Public Instance Methods

activity(options={}, &block) click to toggle source

Serving up the ‘social’ in Social Coding™, the Activity APIs provide access to notifications, subscriptions, and timelines.

    # File lib/github_api/client.rb, line 8
    def activity(options={}, &block)
      @activity ||= ApiFactory.new('Activity', current_options.merge(options), &block)
    end

authorizations(options={}, &block) click to toggle source
Alias for: oauth
emojis(options={}, &block) click to toggle source

    # File lib/github_api/client.rb, line 12
    def emojis(options={}, &block)
      @emojis ||= ApiFactory.new('Emojis', current_options.merge(options), &block)
    end

gists(options={}, &block) click to toggle source

    # File lib/github_api/client.rb, line 16
    def gists(options={}, &block)
      @gists ||= ApiFactory.new('Gists', current_options.merge(options), &block)
    end

git(options={}, &block) click to toggle source
Alias for: git_data
git_data(options={}, &block) click to toggle source

The Git Database API gives you access to read and write raw Git objects to your Git database on GitHub and to list and update your references (branch heads and tags).

    # File lib/github_api/client.rb, line 28
    def git_data(options={}, &block)
      @git_data ||= ApiFactory.new('GitData', current_options.merge(options), &block)
    end

Also aliased as: git
git_ignore(options={}, &block) click to toggle source
Alias for: gitignore
gitignore(options={}, &block) click to toggle source

    # File lib/github_api/client.rb, line 20
    def gitignore(options={}, &block)
      @gitignore ||= ApiFactory.new('Gitignore', current_options.merge(options), &block)
    end

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

    # File lib/github_api/client.rb, line 33
    def issues(options={}, &block)
      @issues ||= ApiFactory.new('Issues', current_options.merge(options), &block)
    end

markdown(options={}, &block) click to toggle source

    # File lib/github_api/client.rb, line 37
    def markdown(options={}, &block)
      @markdown ||= ApiFactory.new('Markdown', current_options.merge(options), &block)
    end

meta(options={}, &block) click to toggle source

    # File lib/github_api/client.rb, line 41
    def meta(options={}, &block)
      @meta ||= ApiFactory.new('Meta', current_options.merge(options), &block)
    end

oauth(options={}, &block) click to toggle source

An API for users to manage their own tokens. You can only access your own tokens, and only through Basic Authentication.

    # File lib/github_api/client.rb, line 47
    def oauth(options={}, &block)
      @oauth ||= ApiFactory.new('Authorizations', current_options.merge(options), &block)
    end

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

    # File lib/github_api/client.rb, line 67
    def octocat(options={}, &block)
      @octocat ||= ApiFactory.new('Say', current_options.merge(options), &block)
    end

organizations(options={}, &block) click to toggle source
Alias for: orgs
orgs(options={}, &block) click to toggle source

    # File lib/github_api/client.rb, line 52
    def orgs(options={}, &block)
      @orgs ||= ApiFactory.new('Orgs', current_options.merge(options), &block)
    end

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

    # File lib/github_api/client.rb, line 57
    def pull_requests(options={}, &block)
      @pull_requests ||= ApiFactory.new('PullRequests', current_options.merge(options), &block)
    end

Also aliased as: pulls
pulls(options={}, &block) click to toggle source
Alias for: pull_requests
repos(options={}, &block) click to toggle source

    # File lib/github_api/client.rb, line 62
    def repos(options={}, &block)
      @repos ||= ApiFactory.new('Repos', current_options.merge(options), &block)
    end

Also aliased as: repositories
repositories(options={}, &block) click to toggle source
Alias for: repos
scopes(options={}, &block) click to toggle source

    # File lib/github_api/client.rb, line 71
    def scopes(options={}, &block)
      @scopes ||= ApiFactory.new('Scopes', current_options.merge(options), &block)
    end

search(options={}, &block) click to toggle source

    # File lib/github_api/client.rb, line 75
    def search(options={}, &block)
      @search ||= ApiFactory.new('Search', current_options.merge(options), &block)
    end

users(options={}, &block) click to toggle source

Many of the resources on the users API provide a shortcut for getting information about the currently authenticated user.

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

[Validate]

Generated with the Darkfish Rdoc Generator 2.