### Home Classes Methods

### In Files

- lib/github_api/repos/statuses.rb

### Parent

API

### Methods

- #all
- #create
- #list

### 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::Repos::Statuses

The Status API allows external services to mark commits with a success, failure, error, or pending state, which is then reflected in pull requests involving those commits.

### Constants

REQUIRED_PARAMS
VALID_STATUS_PARAM_NAMES

### Public Instance Methods

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

Create a status

# Inputs

- `:state` - Required string - State of the status - can be one of

      pending, success, error, or failure.

- `:target_url` - Optional string - Target url to associate with this

      status. This URL will be linked from the GitHub UI to allow users
      to easily see the ‘source’ of the Status.

- `:description` - Optional string - Short description of the status

# Examples

    github = Github.new
    github.repos.statuses.create 'user-name', 'repo-name', 'sha',
      "state" =>  "success",
      "target_url" => "http://ci.example.com/johndoe/my-repo/builds/sha",
      "description" => "Successful build #3 from origin/master"

    # File lib/github_api/repos/statuses.rb, line 51
    def create(*args)
      arguments(args, :required => [:user, :repo, :sha]) do
        sift VALID_STATUS_PARAM_NAMES, :recursive => false
        assert_required REQUIRED_PARAMS
      end
      params = arguments.params

      post_request("/repos/#{user}/#{repo}/statuses/#{sha}", params)
    end

list(*args) click to toggle source

List Statuses for a specific SHA

# Examples

    github = Github.new
    github.repos.statuses.list 'user-name', 'repo-name', 'sha'
    github.repos.statuses.list 'user-name', 'repo-name', 'sha' { |status| ... }

    # File lib/github_api/repos/statuses.rb, line 24
    def list(*args)
      arguments(args, :required => [:user, :repo, :sha])
      params = arguments.params

      response = get_request("/repos/#{user}/#{repo}/statuses/#{sha}", params)
      return response unless block_given?
      response.each { |el| yield el }
    end

Also aliased as: all

[Validate]

Generated with the Darkfish Rdoc Generator 2.