Package com.amilesend.tvmaze.client.api
Class SearchApi
java.lang.Object
com.amilesend.tvmaze.client.api.ApiBase
com.amilesend.tvmaze.client.api.SearchApi
TVMaze API to search for show information.
For more information, please refer to: https://www.tvmaze.com/api#search
For more information, please refer to: https://www.tvmaze.com/api#search
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
The type of alternative identifier type. -
Constructor Summary
ConstructorsConstructorDescriptionSearchApi
(com.amilesend.client.connection.Connection connection) Creates a newSearchApi
object. -
Method Summary
Modifier and TypeMethodDescriptionlookupShow
(SearchApi.ShowLookupIdType type, String externalId) Lookup a show based on an alternative external identifier.searchPeople
(String query) Search for people (e.g., actors, directors, etc.).searchShows
(String query) Search for TV shows for the given query.singleSearchShow
(String query, Show.EmbeddedType... includeEmbeddedTypes) Search for and return a single show for the given query.
-
Constructor Details
-
SearchApi
public SearchApi(com.amilesend.client.connection.Connection connection) Creates a newSearchApi
object.- Parameters:
connection
- the connection
-
-
Method Details
-
searchShows
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
Search for and return a single show for the given query.- Parameters:
query
- the search queryincludeEmbeddedTypes
- the optional embedded types to include in the show- Returns:
- the tv show
- See Also:
-
lookupShow
Lookup a show based on an alternative external identifier.- Parameters:
type
- the id type identifierexternalId
- the external identifier- Returns:
- the tv show
- See Also:
-
searchPeople
Search for people (e.g., actors, directors, etc.).- Parameters:
query
- the search query- Returns:
- the list of persons associated with the query
- See Also:
-