Package com.amilesend.tvmaze.client.api

Class ScheduleApi

java.lang.Object

com.amilesend.tvmaze.client.api.ApiBase

com.amilesend.tvmaze.client.api.ScheduleApi

public class ScheduleApi
extends ApiBase

TVMaze API to retrieve schedule information.
For more information, please refer to https://www.tvmaze.com/api#schedule

Constructor Summary

Constructors

Constructor	Description
ScheduleApi(Connection connection)	Creates a new ScheduleApi object

Method Summary

Modifier and Type	Method	Description
List<Episode>	getFullSchedule()	Retrieves the list of all future episodes.
List<Episode>	getSchedule(String countryCode, LocalDate date)	Retrieves the list of episodes that air in a given country and date.
List<Episode>	getWebStreamingSchedule(String countryCode, LocalDate date)	Retrieves the list of episodes that air on web/streaming channels in a given country and date.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ScheduleApi

public ScheduleApi(Connection connection)

Creates a new ScheduleApi object

Parameters:

connection - the connection

Method Details

getSchedule

public List<Episode> getSchedule(String countryCode,
 LocalDate date)

Retrieves the list of episodes that air in a given country and date.

Parameters:

countryCode - the ISO 3166-1 country code (e.g., "US"), or null

date - the date, or null for the current date

Returns:

the list of airing episodes

getWebStreamingSchedule

public List<Episode> getWebStreamingSchedule(String countryCode,
 LocalDate date)

Retrieves the list of episodes that air on web/streaming channels in a given country and date.

Parameters:

countryCode - the ISO 3166-1 country code (e.g., "US"), or null

date - the date, or null for the current date

Returns:

the list of airing episodes

getFullSchedule

public List<Episode> getFullSchedule()

Retrieves the list of all future episodes. Note: This operation is expensive.

Returns:

the list of future episodes