Class: ThetvdbApi::Search

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

Instance Method Summary collapse

Methods inherited from Base

#api_key_options, #api_key_with_language_options, #language_options

Instance Method Details

#get_episode(options = {}) ⇒ Object

Find the episode data by episode air date.

access: FREE param: options hash

seriesid: This is the seriesid for the series you want to use for finding episodes.
airdate: This is the date the episode aired on you are trying to lookup. This can be supplied in any valid date
         type. Example: 2008-01-01, 2008-1-1, January 1, 2008, 1/1/2008, etc

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



53
54
55
 
# File 'lib/thetvdb_api/search.rb', line 53

def get_episode(options = {})
  get_episode_path_with_params(options).get
end

#get_episode_url(options = {}) ⇒ Object

Find the episode data by episode air date - return only url.

access: FREE param: options hash

seriesid: This is the seriesid for the series you want to use for finding episodes.
airdate: This is the date the episode aired on you are trying to lookup. This can be supplied in any valid date
         type. Example: 2008-01-01, 2008-1-1, January 1, 2008, 1/1/2008, etc

output: url string



66
67
68
 
# File 'lib/thetvdb_api/search.rb', line 66

def get_episode_url(options = {})
  get_episode_path_with_params(options).url
end

#get_series(options = {}) ⇒ Object

Find the series data based on its name.

access: FREE param: options hash

seriesname: TV series name

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



8
9
10
 
# File 'lib/thetvdb_api/search.rb', line 8

def get_series(options = {})
  get_series_path_with_params(options).get
end

#get_series_by_remote_id(options = {}) ⇒ Object

Find the series data by unique ID’s used on other sites.

access: FREE param: options hash

imdbid: IMDb ID (don't use with zap2itid)
zap2itid: Zap2it ID (don't use with imdbid)

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



29
30
31
 
# File 'lib/thetvdb_api/search.rb', line 29

def get_series_by_remote_id(options = {})
  get_series_by_remote_id_path_with_params(options).get
end

#get_series_by_remote_id_url(options = {}) ⇒ Object

Find the series data by unique ID’s used on other sites - return only url.

access: FREE param: options hash

seriesid: IMDb ID (don't use with zap2itid)
zap2itid: Zap2it ID (don't use with imdbid)

output: url string



40
41
42
 
# File 'lib/thetvdb_api/search.rb', line 40

def get_series_by_remote_id_url(options = {})
  get_series_by_remote_id_path_with_params(options).url
end

#get_series_url(options = {}) ⇒ Object

Find the series data based on its name - return only url.

access: FREE param: options hash

seriesname: TV series name

output: url string



18
19
20
 
# File 'lib/thetvdb_api/search.rb', line 18

def get_series_url(options = {})
  get_series_path_with_params(options).url
end