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
143 144 145 |
# File 'lib/octokit/client/events.rb', line 143 def issue_event(repo, number, = {}) paginate "repos/#{Repository.new(repo)}/issues/events/#{number}", end |
#issue_events(repo, number, options = {}) ⇒ Array<Sawyer::Resource>
List events for an Issue
130 131 132 |
# File 'lib/octokit/client/events.rb', line 130 def issue_events(repo, number, = {}) paginate "repos/#{Repository.new(repo)}/issues/#{number}/events", end |
#organization_events(org, options = {}) ⇒ Array<Sawyer::Resource>
List all events for an organization
Requires authenticated client.
92 93 94 |
# File 'lib/octokit/client/events.rb', line 92 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
103 104 105 |
# File 'lib/octokit/client/events.rb', line 103 def organization_public_events(org, = {}) paginate "orgs/#{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
47 48 49 |
# File 'lib/octokit/client/events.rb', line 47 def received_events(user, = {}) paginate "users/#{user}/received_events", end |
#received_public_events(user, options = {}) ⇒ Array<Sawyer::Resource>
List public events a user has received
57 58 59 |
# File 'lib/octokit/client/events.rb', line 57 def received_public_events(user, = {}) paginate "users/#{user}/received_events/public", end |
#repository_events(repo, options = {}) ⇒ Array<Sawyer::Resource>
List events for a repository
68 69 70 |
# File 'lib/octokit/client/events.rb', line 68 def repository_events(repo, = {}) paginate "repos/#{Repository.new(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
116 117 118 |
# File 'lib/octokit/client/events.rb', line 116 def repository_issue_events(repo, = {}) paginate "repos/#{Repository.new(repo)}/issues/events", end |
#repository_network_events(repo, options = {}) ⇒ Array<Sawyer::Resource>
List public events for a repository’s network
79 80 81 |
# File 'lib/octokit/client/events.rb', line 79 def repository_network_events(repo, = {}) paginate "networks/#{Repository.new(repo)}/events", end |
#user_events(user, options = {}) ⇒ Array<Sawyer::Resource>
List all user events
26 27 28 |
# File 'lib/octokit/client/events.rb', line 26 def user_events(user, = {}) paginate "users/#{user}/events", end |
#user_public_events(user, options = {}) ⇒ Array<Sawyer::Resource>
List public user events
37 38 39 |
# File 'lib/octokit/client/events.rb', line 37 def user_public_events(user, = {}) paginate "users/#{user}/events/public", end |