Parent

Methods

Class/Module Index [+]

Quicksearch

Github::Client::Issues::Events

Public Instance Methods

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

Get a single event

@example

github = Github.new
github.issues.events.get 'user-name', 'repo-name', 'event-id'

@api public

# File lib/github_api/client/issues/events.rb, line 39
def get(*args)
  arguments(args, :required => [:user, :repo, :id])
  params = arguments.params

  get_request("/repos/#{arguments.user}/#{arguments.repo}/issues/events/#{arguments.id}", params)
end
Also aliased as: find
list(*args) click to toggle source

List events for an issue

@example

github = Github.new
github.issues.events.list 'user-name', 'repo-name',
  issue_number: 'issue-number'

List events for a repository

@example

github = Github.new
github.issues.events.list 'user-name', 'repo-name'

@api public

# File lib/github_api/client/issues/events.rb, line 18
def list(*args)
  arguments(args, required: [:user, :repo])
  params = arguments.params

  response = if (issue_number = params.delete('issue_number'))
    get_request("/repos/#{arguments.user}/#{arguments.repo}/issues/#{issue_number}/events", params)
  else
    get_request("/repos/#{arguments.user}/#{arguments.repo}/issues/events", 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.