### Home Classes Methods

### In Files

- lib/github_api/repos/comments.rb

### Parent

Github::API

### Methods

- #all
- #create
- #delete
- #find
- #get
- #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::Repos::Comments

### Constants

REQUIRED_COMMENT_OPTIONS
VALID_COMMENT_OPTIONS

### Public Instance Methods

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

Creates a commit comment

# Inputs

- `:body` - Required string.

- `:comment_id` - Required string - Sha of the commit to comment on.

- `:line` - Required number - Line number in the file to comment on.

- `:path` - Required string - Relative path of the file to comment on.

- `:position` - Required number - Line index in the diff to comment on.

# Examples

    github = Github.new
    github.repos.comments.create 'user-name', 'repo-name', 'sha-key',
      "body" => "Nice change",
      "commit_id" => "6dcb09b5b57875f334f61aebed695e2e4193db5e",
      "line" => 1,
      "path" =>  "file1.txt",
      "position" =>  4

    # File lib/github_api/repos/comments.rb, line 73
    def create(*args)
      arguments(args, :required => [:user, :repo, :sha]) do
        sift VALID_COMMENT_OPTIONS
        assert_required REQUIRED_COMMENT_OPTIONS
      end
      params = arguments.params

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

delete(*args) click to toggle source

Deletes a commit comment

# Examples

    github = Github.new
    github.repos.comments.delete 'user-name', 'repo-name', 'comment-id'

    # File lib/github_api/repos/comments.rb, line 108
    def delete(*args)
      arguments(args, :required => [:user, :repo, :comment_id])
      params = arguments.params

      delete_request("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
    end

find(*args) click to toggle source
Alias for: get
get(*args) click to toggle source

Gets a single commit comment

# Examples

    github = Github.new
    github.repos.comments.get 'user-name', 'repo-name', 'comment-id'

    # File lib/github_api/repos/comments.rb, line 47
    def get(*args)
      arguments(args, :required => [:user, :repo, :comment_id])
      params = arguments.params

      get_request("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
    end

Also aliased as: find
list(*args) click to toggle source

List commit comments for a repository

# Examples

    github = Github.new
    github.repos.comments.list 'user-name', 'repo-name'
    github.repos.comments.list 'user-name', 'repo-name' { |com| ... }

List comments for a single commit

# Examples

    github.repos.comments.list 'user-name', 'repo-name',
     :sha => '6dcb09b5b57875f334f61aebed695e2e4193db5e'

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

      response = if (sha = params.delete('sha'))
        get_request("/repos/#{user}/#{repo}/commits/#{sha}/comments", params)
      else
        get_request("/repos/#{user}/#{repo}/comments", params)
      end
      return response unless block_given?
      response.each { |el| yield el }
    end

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

Update a commit comment

# Inputs

- `:body` - Required string.

# Examples

    github = Github.new
    github.repos.comments.update 'user-name', 'repo-name',
      'comment-id', "body" => "Nice change"

    # File lib/github_api/repos/comments.rb, line 93
    def update(*args)
      arguments(args, :required => [:user, :repo, :comment_id]) do
        assert_required REQUIRED_COMMENT_OPTIONS
      end
      params = arguments.params

      patch_request("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.