Class: ThetvdbApi::Episode

Inherits:
Base
  • Object
show all
Defined in:
lib/thetvdb_api/episode.rb

Instance Method Summary collapse

Methods inherited from Base

#api_key_options, #api_key_with_language_options, #language_options

Instance Method Details

#find(options = {}) ⇒ Object

Find the episode data by episode id.

access: FREE param: options hash

episode_id: TV episode ID

output: XML string (example: thetvdb.com/wiki/index.php/API:Base_Episode_Record)



78
79
80
 
# File 'lib/thetvdb_api/episode.rb', line 78

def find(options = {})
  find_path_with_params(options).get
end

#find_by_absolute_order(options = {}) ⇒ Object

Find the episode data, sorts using the absolute ordering method.

access: FREE param: options hash

series_id: TV series ID
absolute: absolute number in series

output: XML string (example: thetvdb.com/wiki/index.php/API:Base_Episode_Record)



57
58
59
 
# File 'lib/thetvdb_api/episode.rb', line 57

def find_by_absolute_order(options = {})
  find_by_absolute_order_path_with_params(options).get
end

#find_by_absolute_order_url(options = {}) ⇒ Object

Find the episode data, sorts using the absolute ordering method - return only url.

access: FREE param: options hash

series_id: TV series ID
absolute: absolute number in series

output: url string



68
69
70
 
# File 'lib/thetvdb_api/episode.rb', line 68

def find_by_absolute_order_url(options = {})
  find_by_absolute_order_path_with_params(options).url
end

#find_by_default_order(options = {}) ⇒ Object

Find the episode data, sorts using the default ordering method.

access: FREE param: options hash

series_id: TV series ID
season: season number
episode: episode number in season

output: XML string (example: thetvdb.com/wiki/index.php/API:Base_Episode_Record)



10
11
12
 
# File 'lib/thetvdb_api/episode.rb', line 10

def find_by_default_order(options = {})
  find_by_order(options.merge(order: 'default'))
end

#find_by_default_order_url(options = {}) ⇒ Object

Find the episode data, sorts using the default ordering method - return only url.

access: FREE param: options hash

series_id: TV series ID
season: season number
episode: episode number in season

output: url string



22
23
24
 
# File 'lib/thetvdb_api/episode.rb', line 22

def find_by_default_order_url(options = {})
  find_by_order_url(options.merge(order: 'default'))
end

#find_by_dvd_order(options = {}) ⇒ Object

Find the episode data, sorts using the dvd ordering method.

access: FREE param: options hash

series_id: TV series ID
season: season number
episode: episode number in season

output: XML string (example: thetvdb.com/wiki/index.php/API:Base_Episode_Record)



34
35
36
 
# File 'lib/thetvdb_api/episode.rb', line 34

def find_by_dvd_order(options = {})
  find_by_order(options.merge(order: 'dvd'))
end

#find_by_dvd_order_url(options = {}) ⇒ Object

Find the episode data, sorts using the dvd ordering method - return only url.

access: FREE param: options hash

series_id: TV series ID
season: season number
episode: episode number in season

output: url string



46
47
48
 
# File 'lib/thetvdb_api/episode.rb', line 46

def find_by_dvd_order_url(options = {})
  find_by_order_url(options.merge(order: 'dvd'))
end

#find_url(options = {}) ⇒ Object

Find the episode data by episode id - return only url.

access: FREE param: options hash

episode_id: TV episode ID

output: url string



88
89
90
 
# File 'lib/thetvdb_api/episode.rb', line 88

def find_url(options = {})
  find_path_with_params(options).url
end