### Home Classes Methods

### In Files

- lib/github_api/activity/events.rb

### Parent

Github::API

### Methods

- #issue
- #issue_events
- #issues
- #list_issue_events
- #list_org_events
- #list_organization_events
- #list_orgs
- #list_public
- #list_public_events
- #list_repo_network_events
- #list_repository_events
- #list_repository_network_events
- #list_user_org
- #list_user_org_events
- #list_user_organization_events
- #list_user_performed
- #list_user_received
- #network
- #org
- #organization
- #performed
- #public
- #public_events
- #received
- #repo_events
- #repo_network
- #repos
- #repository
- #repository_events
- #repository_network
- #user_org
- #user_organization
- #user_performed
- #user_received

### 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::Activity::Events

### Public Instance Methods

issue(*args) click to toggle source

List all issue events for a given repository

# Examples

    github = Github.new
    github.activity.events.issue 'user-name', 'repo-name'
    github.activity.events.issue 'user-name', 'repo-name' { |event| ... }

    github.activity.events.issue user: 'user-name', repo: 'repo-name'
    github.activity.events.issue user: 'user-name', repo: 'repo-name' { |event| ... }

    # File lib/github_api/activity/events.rb, line 55
    def issue(*args)
      arguments(args, :required => [:user, :repo])
      params = arguments.params

      response = get_request("/repos/#{user}/#{repo}/issues/events", params)
      return response unless block_given?
      response.each { |el| yield el }
    end

Also aliased as: issues, issue_events, list_issue_events
issue_events(*args) click to toggle source
Alias for: issue
issues(*args) click to toggle source
Alias for: issue
list_issue_events(*args) click to toggle source
Alias for: issue
list_org_events(*args) click to toggle source
Alias for: org
list_organization_events(*args) click to toggle source
Alias for: org
list_orgs(*args) click to toggle source
Alias for: org
list_public(*args) click to toggle source
Alias for: public
list_public_events(*args) click to toggle source
Alias for: public
list_repo_network_events(*args) click to toggle source
Alias for: network
list_repository_events(*args) click to toggle source
Alias for: repository
list_repository_network_events(*args) click to toggle source
Alias for: network
list_user_org(*args) click to toggle source
Alias for: user_org
list_user_org_events(*args) click to toggle source
Alias for: user_org
list_user_organization_events(*args) click to toggle source
Alias for: user_org
list_user_performed(*args) click to toggle source
Alias for: performed
list_user_received(*args) click to toggle source
Alias for: received
network(*args) click to toggle source

List all public events for a network of repositories

# Examples

    github = Github.new
    github.activity.events.network 'user-name', 'repo-name'
    github.activity.events.network 'user-name', 'repo-name' { |event| ... }

    github.activity.events.network user: 'user-name', repo: 'repo-name'
    github.activity.events.network user: 'user-name', repo: 'repo-name' { |event| ... }

    # File lib/github_api/activity/events.rb, line 77
    def network(*args)
      arguments(args, :required => [:user, :repo])

      response = get_request("/networks/#{user}/#{repo}/events", arguments.params)
      return response unless block_given?
      response.each { |el| yield el }
    end

Also aliased as: repo_network, repository_network, list_repo_network_events, list_repository_network_events
org(*args) click to toggle source

List all public events for an organization

# Examples

    github = Github.new
    github.activity.events.org 'org-name'
    github.activity.events.org 'org-name' { |event| ... }

    github.activity.events.org org: 'org-name'
    github.activity.events.org org: 'org-name' { |event| ... }

    # File lib/github_api/activity/events.rb, line 99
    def org(*args)
      arguments(args, :required => [:org_name])

      response = get_request("/orgs/#{org_name}/events", arguments.params)
      return response unless block_given?
      response.each { |el| yield el }
    end

Also aliased as: organization, list_orgs, list_org_events, list_organization_events
organization(*args) click to toggle source
Alias for: org
performed(*args) click to toggle source

List all events that a user has performed

If you are authenticated as the given user, you will see your private events. Otherwise, you’ll only see public events.

# Examples

    github = Github.new
    github.activity.events.performed 'user-name'
    github.activity.events.performed 'user-name' { |event| ... }

List all public events that a user has performed

# Examples

    github = Github.new
    github.activity.events.performed 'user-name', :public => true
    github.activity.events.performed 'user-name', :public => true { |event| ... }

    # File lib/github_api/activity/events.rb, line 162
    def performed(*args)
      arguments(args, :required => [:user])
      params = arguments.params

      public_events = if params['public']
        params.delete('public')
        '/public'
      end

      response = get_request("/users/#{user}/events#{public_events}", params)
      return response unless block_given?
      response.each { |el| yield el }
    end

Also aliased as: user_performed, list_user_performed
public(*args) click to toggle source

List all public events

# Examples

    github = Github.new
    github.activity.events.public
    github.activity.events.public { |event| ... }

    # File lib/github_api/activity/events.rb, line 12
    def public(*args)
      arguments(args)

      response = get_request("/events", arguments.params)
      return response unless block_given?
      response.each { |el| yield el }
    end

Also aliased as: public_events, list_public, list_public_events
public_events(*args) click to toggle source
Alias for: public
received(*args) click to toggle source

List all events that a user has received

These are events that you’ve received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you’ll only see public events.

# Examples

    github = Github.new
    github.activity.events.received 'user-name'
    github.activity.events.received 'user-name' { |event| ... }

List all public events that a user has received

# Examples

    github = Github.new
    github.activity.events.received 'user-name', :public => true
    github.activity.events.received 'user-name', :public => true { |event| ... }

    # File lib/github_api/activity/events.rb, line 129
    def received(*args)
      arguments(args, :required => [:user])
      params = arguments.params

      public_events = if params['public']
        params.delete('public')
        '/public'
      end

      response = get_request("/users/#{user}/received_events#{public_events}", params)
      return response unless block_given?
      response.each { |el| yield el }
    end

Also aliased as: user_received, list_user_received
repo_events(*args) click to toggle source
Alias for: repository
repo_network(*args) click to toggle source
Alias for: network
repos(*args) click to toggle source
Alias for: repository
repository(*args) click to toggle source

List all repository events for a given user

# Examples

    github = Github.new
    github.activity.events.repository 'user-name', 'repo-name'
    github.activity.events.repository 'user-name', 'repo-name' { |event| ... }

    github.activity.events.repository user: 'user-name', repo: 'repo-name'
    github.activity.events.repository user: 'user-name', repo: 'repo-name' {|event| ... }

    # File lib/github_api/activity/events.rb, line 33
    def repository(*args)
      arguments(args, :required => [:user, :repo])

      response = get_request("/repos/#{user}/#{repo}/events", arguments.params)
      return response unless block_given?
      response.each { |el| yield el }
    end

Also aliased as: repos, repo_events, repository_events, list_repository_events
repository_events(*args) click to toggle source
Alias for: repository
repository_network(*args) click to toggle source
Alias for: network
user_org(*args) click to toggle source

List all events for an organization

This is the user’s organization dashboard. You must be authenticated as the user to view this.

# Examples

    github = Github.new
    github.activity.events.user_org 'user-name', 'org-name'
    github.activity.events.user_org 'user-name', 'org-name' { |event| ... }

    github.activity.events.user_org user: 'user-name', org_name: 'org-name'
    github.activity.events.user_org user: 'user-name', org_name: 'org-name' {|event| ...}

    # File lib/github_api/activity/events.rb, line 191
    def user_org(*args)
      arguments(args, :required => [:user, :org_name])
      params = arguments.params

      response = get_request("/users/#{user}/events/orgs/#{org_name}", params)
      return response unless block_given?
      response.each { |el| yield el }
    end

Also aliased as: user_organization, list_user_org, list_user_org_events, list_user_organization_events
user_organization(*args) click to toggle source
Alias for: user_org
user_performed(*args) click to toggle source
Alias for: performed
user_received(*args) click to toggle source
Alias for: received

[Validate]

Generated with the Darkfish Rdoc Generator 2.