Class SearchApi

java.lang.Object
com.amilesend.tvmaze.client.api.ApiBase
com.amilesend.tvmaze.client.api.SearchApi

public class SearchApi extends ApiBase
TVMaze API to search for show information.
For more information, please refer to: https://www.tvmaze.com/api#search
  • Constructor Details

    • SearchApi

      public SearchApi(com.amilesend.client.connection.Connection connection)
      Creates a new SearchApi object.
      Parameters:
      connection - the connection
  • Method Details

    • searchShows

      public List<ShowResult> searchShows(String query)
      Search for TV shows for the given query.
      Parameters:
      query - the search query
      Returns:
      the list of shows for the associated query
      See Also:
    • singleSearchShow

      public Show singleSearchShow(String query, Show.EmbeddedType... includeEmbeddedTypes)
      Search for and return a single show for the given query.
      Parameters:
      query - the search query
      includeEmbeddedTypes - the optional embedded types to include in the show
      Returns:
      the tv show
      See Also:
    • lookupShow

      public Show lookupShow(SearchApi.ShowLookupIdType type, String externalId)
      Lookup a show based on an alternative external identifier.
      Parameters:
      type - the id type identifier
      externalId - the external identifier
      Returns:
      the tv show
      See Also:
    • searchPeople

      public List<PersonResult> searchPeople(String query)
      Search for people (e.g., actors, directors, etc.).
      Parameters:
      query - the search query
      Returns:
      the list of persons associated with the query
      See Also: