### Home Classes Methods

### In Files

- lib/github_api/pull_requests/comments.rb

### Parent

Github::API

### Methods

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

### Constants

VALID_REQUEST_COM_PARAM_NAMES

### Public Instance Methods

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

Create a pull request comment

# Inputs

- `:body` - Required string

- `:commit_id` - Required string - sha of the commit 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.pull_requests.comments.create 'user-name','repo-name','request-id',
     "body" => "Nice change",
     "commit_id" => "6dcb09b5b57875f334f61aebed695e2e4193db5e",
     "path" => "file1.txt",
     "position" => 4

# Alternative Inputs

Instead of passing commit_id, path, and position you can reply to an existing Pull Request Comment like this

- `:body` - Required string

- `:in_reply_to` - Required number - comment id to reply to.

# Examples

    github = Github.new
    github.pull_requests.comments.create 'user-name','repo-name','request-id',
      "body" => "Nice change",
      "in_reply_to" => 4

    # File lib/github_api/pull_requests/comments.rb, line 91
    def create(*args)
      arguments(args, :required => [:user, :repo, :request_id]) do
        sift VALID_REQUEST_COM_PARAM_NAMES
      end
      # _validate_reply_to(params)

      post_request("/repos/#{user}/#{repo}/pulls/#{request_id}/comments", arguments.params)
    end

delete(*args) click to toggle source

Delete a pull request comment

# Examples

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

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

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

edit(*args) click to toggle source

Edit a pull request comment

# Inputs

- `:body` - Required string

# Examples

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

    # File lib/github_api/pull_requests/comments.rb, line 110
    def edit(*args)
      arguments(args, :required => [:user, :repo, :comment_id]) do
        sift VALID_REQUEST_COM_PARAM_NAMES
      end

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

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

Get a single comment for pull requests

# Examples

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

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

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

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

List comments on a pull request

# Examples

    github = Github.new
    github.pull_requests.comments.list 'user-name', 'repo-name', request_id: 'id'

List comments in a repository

By default, Review Comments are ordered by ascending ID.

# Parameters

- `:sort` - Optional string, `created` or `updated`

- `:direction` - Optional string, `asc` or `desc`.

      Ignored with sort parameter.

- `:since` - Optional string of a timestamp in ISO 8601

      format: YYYY-MM-DDTHH:MM:SSZ

# Examples

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

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

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

Also aliased as: all

[Validate]

Generated with the Darkfish Rdoc Generator 2.