Module: Octokit::Client::Events
- Included in:
- Octokit::Client
- Defined in:
- lib/octokit/client/events.rb
Overview
Method for the Events API
Instance Method Summary collapse
-
#issue_event(repo, number, options = {}) ⇒ Sawyer::Resource
Get information on a single Issue Event.
-
#issue_events(repo, number, options = {}) ⇒ Array<Sawyer::Resource>
List events for an Issue.
-
#organization_events(org, options = {}) ⇒ Array<Sawyer::Resource>
List all events for an organization.
-
#organization_public_events(org, options = {}) ⇒ Array<Sawyer::Resource>
List an organization's public events.
-
#public_events(options = {}) ⇒ Array<Sawyer::Resource>
List all public events for GitHub.
-
#received_events(user, options = {}) ⇒ Array<Sawyer::Resource>
List events that a user has received.
-
#received_public_events(user, options = {}) ⇒ Array<Sawyer::Resource>
List public events a user has received.
-
#repository_events(repo, options = {}) ⇒ Array<Sawyer::Resource>
List events for a repository.
-
#repository_issue_events(repo, options = {}) ⇒ Array<Sawyer::Resource>
(also: #repo_issue_events)
Get all Issue Events for a given Repository.
-
#repository_network_events(repo, options = {}) ⇒ Array<Sawyer::Resource>
List public events for a repository's network.
-
#user_events(user, options = {}) ⇒ Array<Sawyer::Resource>
List all user events.
-
#user_public_events(user, options = {}) ⇒ Array<Sawyer::Resource>
List public user events.
Instance Method Details
#issue_event(repo, number, options = {}) ⇒ Sawyer::Resource
Get information on a single Issue Event
146 147 148 |
# File 'lib/octokit/client/events.rb', line 146 def issue_event(repo, number, = {}) paginate "#{Repository.path repo}/issues/events/#{number}", end |
#issue_events(repo, number, options = {}) ⇒ Array<Sawyer::Resource>
List events for an Issue
133 134 135 |
# File 'lib/octokit/client/events.rb', line 133 def issue_events(repo, number, = {}) paginate "#{Repository.path repo}/issues/#{number}/events", end |
#organization_events(org, options = {}) ⇒ Array<Sawyer::Resource>
List all events for an organization
Requires authenticated client.
95 96 97 |
# File 'lib/octokit/client/events.rb', line 95 def organization_events(org, = {}) paginate "users/#{login}/events/orgs/#{org}", end |
#organization_public_events(org, options = {}) ⇒ Array<Sawyer::Resource>
List an organization's public events
106 107 108 |
# File 'lib/octokit/client/events.rb', line 106 def organization_public_events(org, = {}) paginate "#{Organization.path org}/events", end |
#public_events(options = {}) ⇒ Array<Sawyer::Resource>
List all public events for GitHub
16 17 18 |
# File 'lib/octokit/client/events.rb', line 16 def public_events( = {}) paginate "events", end |
#received_events(user, options = {}) ⇒ Array<Sawyer::Resource>
List events that a user has received
49 50 51 |
# File 'lib/octokit/client/events.rb', line 49 def received_events(user, = {}) paginate "#{User.path user}/received_events", end |
#received_public_events(user, options = {}) ⇒ Array<Sawyer::Resource>
List public events a user has received
60 61 62 |
# File 'lib/octokit/client/events.rb', line 60 def received_public_events(user, = {}) paginate "#{User.path user}/received_events/public", end |
#repository_events(repo, options = {}) ⇒ Array<Sawyer::Resource>
List events for a repository
71 72 73 |
# File 'lib/octokit/client/events.rb', line 71 def repository_events(repo, = {}) paginate "#{Repository.path repo}/events", end |
#repository_issue_events(repo, options = {}) ⇒ Array<Sawyer::Resource> Also known as: repo_issue_events
Get all Issue Events for a given Repository
119 120 121 |
# File 'lib/octokit/client/events.rb', line 119 def repository_issue_events(repo, = {}) paginate "#{Repository.path repo}/issues/events", end |
#repository_network_events(repo, options = {}) ⇒ Array<Sawyer::Resource>
List public events for a repository's network
82 83 84 |
# File 'lib/octokit/client/events.rb', line 82 def repository_network_events(repo, = {}) paginate "networks/#{Repository.new(repo)}/events", end |