Class: Forem::Services::PodcastEpisodeService

Inherits:
BaseService
  • Object
show all
Defined in:
lib/forem/services/podcast_episode_service.rb

Overview

Service for interacting with the Forem Podcast Episodes API.

Access via Client#podcast_episodes. All methods inject the client's requestor automatically so no additional configuration is required.

Examples:

client = Forem::Client.new("your-api-key")
episodes = client.podcast_episodes.list(username: "codenewbies")

See Also:

Instance Method Summary collapse

Methods inherited from BaseService

#initialize

Constructor Details

This class inherits a constructor from Forem::Services::BaseService

Instance Method Details

#list(params = {}, opts = {}) ⇒ Array<PodcastEpisode>

List podcast episodes.

Examples:

client.podcast_episodes.list(username: "codenewbies", per_page: 20)

Parameters:

  • params (Hash) (defaults to: {}) —

    query parameters

  • opts (Hash) (defaults to: {}) —

    per-request options

Options Hash (params):

  • :page (Integer) —

    page number (default: 1)

  • :per_page (Integer) —

    number of results per page (max: 1000)

  • :username (String) —

    filter episodes by the podcast owner's username

Returns:

See Also:



29
30
31
 
# File 'lib/forem/services/podcast_episode_service.rb', line 29

def list(params = {}, opts = {})
  PodcastEpisode.list(params, opts_with_requestor(opts))
end