Module: Octokit::Client::Feeds

Included in:

Octokit::Client

Defined in:

lib/octokit/client/feeds.rb

Overview

Methods for the Feeds API

See Also:

• https://developer.github.com/v3/activity/feeds/

Instance Method Summary

• #feed(name, options = {}) ⇒ Feed

  Get a Feed by name.

• #feeds ⇒ Array<Sawyer::Resource>

  List Feeds.

Instance Method Details

#feed(name, options = {}) ⇒ Feed

Get a Feed by name

Parameters:

• name (Symbol, String) —

  Name of feed to retrieve.

Returns:

• (Feed) —

  Parsed feed in the format returned by the configured parser.

# File 'lib/octokit/client/feeds.rb', line 25

def feed(name, options = {})
  if rel = feeds._links[name]
    get rel.href, accept: rel.type, options: options
  end
end

#feeds ⇒ Array<Sawyer::Resource>

List Feeds

The feeds returned depend on authentication, see the GitHub API docs for more information.

Returns:

• (Array<Sawyer::Resource>) —

  list of feeds

See Also:

• https://developer.github.com/v3/activity/feeds/#list-feeds

# File 'lib/octokit/client/feeds.rb', line 16

def feeds
  get 'feeds'
end