Class PeopleApi

java.lang.Object
com.amilesend.tvmaze.client.api.ApiBase
com.amilesend.tvmaze.client.api.PeopleApi
public class PeopleApi extends ApiBase
TVMaze API to retrieve people information.
For more information, please refer to https://www.tvmaze.com/api#people

  • Constructor Summary

    Constructors
    Constructor
    Description
    PeopleApi(com.amilesend.client.connection.Connection connection)
    Creates a new PeopleApi object.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<CastCredit>
    getCastCredits(int personId, boolean isShowIncluded)
    Retrieves the list of show-level cast credits for a specific person.
    List<CrewCredit>
    getCrewCredits(int personId, boolean isShowIncluded)
    Retrieves the list of show-level crew credits for a specific person.
    List<CastCredit>
    getGuestCastCredits(int personId, boolean isEpisodeIncluded)
    Retrieves the list of episode-level guest cast credits for a specific person.
    List<Person>
    getIndex(int pageNum)
    Gets the list of all persons in the TVMaze database.
    Person
    getPerson(int personId, boolean isCastCreditsIncluded)
    Retrieves information for a specific person.

    Methods inherited from class Object

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

  • Constructor Details

    • PeopleApi

      public PeopleApi(com.amilesend.client.connection.Connection connection)
      Creates a new PeopleApi object.
      Parameters:
      connection - the connection

  • Method Details

    • getPerson

      public Person getPerson(int personId, boolean isCastCreditsIncluded)
      Retrieves information for a specific person.
      Parameters:
      personId - the person identifier
      isCastCreditsIncluded - if true, include cast credits in the response; else, false
      Returns:
      the person
      See Also:

    • getCastCredits

      public List<CastCredit> getCastCredits(int personId, boolean isShowIncluded)
      Retrieves the list of show-level cast credits for a specific person.
      Parameters:
      personId - the person identifier
      isShowIncluded - if true, include show information in the response; else, false
      Returns:
      the list of cast credits
      See Also:

    • getCrewCredits

      public List<CrewCredit> getCrewCredits(int personId, boolean isShowIncluded)
      Retrieves the list of show-level crew credits for a specific person.
      Parameters:
      personId - the person identifier
      isShowIncluded - if true, include show information in the response; else, false
      Returns:
      the list of crew credits
      See Also:

    • getGuestCastCredits

      public List<CastCredit> getGuestCastCredits(int personId, boolean isEpisodeIncluded)
      Retrieves the list of episode-level guest cast credits for a specific person.
      Parameters:
      personId - the person identifier
      isEpisodeIncluded - if true, include episode information in the response; else, false
      Returns:
      the list of guest cast credits
      See Also:

    • getIndex

      public List<Person> getIndex(int pageNum)
      Gets the list of all persons in the TVMaze database. Note: This is paginated and requires manual specification of the page number with a maximum of 250 shows per response. This operation will throw a RequestException when no more pages exist.
      Parameters:
      pageNum - the page number
      Returns:
      the list of persons
      Throws:
      com.amilesend.client.connection.RequestException - if there are no more persons to return
      See Also: