### Home Classes Methods

### In Files

- lib/github_api/activity/watching.rb

### Parent

Github::API

### Methods

- #all
- #list
- #unwatch
- #watch
- #watched
- #watching?

### 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::Watching

Watching a Repository registers the user to receive notificactions on new discussions, as well as events in the user’s activity feed.

### Public Instance Methods

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

List repo watchers

# Examples

    github = Github.new :user => 'user-name', :repo => 'repo-name'
    github.activity.watching.list
    github.activity.watching.list { |watcher| ... }

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

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

Also aliased as: all
unwatch(*args) click to toggle source

Stop watching a repository

You need to be authenticated to stop watching a repository.

# Examples

    github = Github.new
    github.activity.watching.unwatch 'user-name', 'repo-name'

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

      delete_request("/user/subscriptions/#{user}/#{repo}", arguments.params)
    end

watch(*args) click to toggle source

Watch a repository

You need to be authenticated to watch a repository

# Examples

    github = Github.new
    github.activity.watching.watch 'user-name', 'repo-name'

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

      put_request("/user/subscriptions/#{user}/#{repo}", arguments.params)
    end

watched(*args) click to toggle source

List repos being watched by a user

# Examples

    github = Github.new
    github.activity.watching.watched :user => 'user-name'

List repos being watched by the authenticated user

# Examples

    github = Github.new :oauth_token => '...'
    github.activity.watching.watched

    # File lib/github_api/activity/watching.rb, line 35
    def watched(*args)
      params = arguments(args).params

      response = if (user_name = params.delete('user'))
        get_request("/users/#{user_name}/subscriptions", params)
      else
        get_request("/user/subscriptions", params)
      end
      return response unless block_given?
      response.each { |el| yield el }
    end

watching?(*args) click to toggle source

Check if you are watching a repository

Returns `true` if this repo is watched by you, `false` otherwise

# Examples

    github = Github.new
    github.activity.watching.watching? 'user-name', 'repo-name'

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

      get_request("/user/subscriptions/#{user}/#{repo}", arguments.params)
      true
    rescue Github::Error::NotFound
      false
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.