Interface QueryParameterBasedRequest

All Known Subinterfaces:

AccountBasedRequest, BodyBasedRequest, CollectionBasedRequest, GuestSessionBasedRequest, SessionBasedRequest

All Known Implementing Classes:

AccountAndSessionBasedPaginatedRequestBase, AddFavoriteRequest, AddMovieRequest, AddRatingRequest, AddRatingRequest, AddRatingRequest, AddWatchlistRequest, ChangesRequestBase, CheckItemStatusRequest, ClearListRequest, CompanyRequestBase, CreateListRequest, CreateSessionRequest, DeleteListRequest, DeleteRatingRequest, DeleteRatingRequest, DeleteRatingRequest, DeleteSessionRequest, DiscoverMoviesRequest, DiscoverRequestBase, DiscoverTvRequest, EpisodeRequestBase, FindByIdRequest, GetAccountDetailsForSessionRequest, GetAccountDetailsRequest, GetAccountStatesRequest, GetAccountStatesRequest, GetAccountStatesRequest, GetAccountStatesRequest, GetAggregateCreditsRequest, GetAggregateCreditsRequest, GetAiringTodayRequest, GetAllTrendingRequest, GetAlternativeNamesRequest, GetAlternativeNamesRequest, GetAlternativeTitlesRequest, GetAlternativeTitlesRequest, GetAvailableRegionsRequest, GetChangesRequest, GetChangesRequest, GetChangesRequest, GetChangesRequest, GetChangesRequest, GetCollectionDetailsRequest, GetCollectionImagesRequest, GetCombinedCreditsRequest, GetCompanyDetailsRequest, GetCompanyImagesRequest, GetContentRatingsRequest, GetCreditDetailsRequest, GetCreditsRequest, GetCreditsRequest, GetCreditsRequest, GetCreditsRequest, GetEpisodeDetailsRequest, GetEpisodeGroupsRequest, GetExternalIdsRequest, GetExternalIdsRequest, GetExternalIdsRequest, GetExternalIdsRequest, GetExternalIDsRequest, GetFavoriteMoviesRequest, GetFavoriteTvShowsRequest, GetGenresRequestBase, GetImagesRequest, GetImagesRequest, GetImagesRequest, GetImagesRequest, GetImagesRequest, GetImagesRequest, GetKeywordDetailsRequest, GetKeywordsRequest, GetKeywordsRequest, GetListDetailsRequest, GetListsRequest, GetListsRequest, GetListsRequest, GetMovieChangesRequest, GetMovieCreditsRequest, GetMovieDetailsRequest, GetMovieGenresRequest, GetMovieProvidersRequest, GetNetworkDetailsRequest, GetNowPlayingRequest, GetOnTheAirRequest, GetPersonChangesRequest, GetPersonDetailsRequest, GetPopularPersonsRequest, GetPopularRequest, GetPopularRequest, GetRatedMoviesRequest, GetRatedMoviesRequest, GetRatedTvEpisodesRequest, GetRatedTvEpisodesRequest, GetRatedTvShowsRequest, GetRatedTvShowsRequest, GetRecommendationsRequest, GetRecommendationsRequest, GetReleaseDatesRequest, GetReviewDetailsRequest, GetReviewsRequest, GetReviewsRequest, GetScreenedTheatricallyRequest, GetSeasonDetailsRequest, GetSeriesDetailsRequest, GetSimilarRequest, GetSimilarRequest, GetTopRatedRequest, GetTopRatedRequest, GetTranslationsRequest, GetTranslationsRequest, GetTranslationsRequest, GetTranslationsRequest, GetTranslationsRequest, GetTranslationsRequest, GetTrendingMoviesRequest, GetTrendingPeopleRequest, GetTrendingRequestBase, GetTrendingTvRequest, GetTvChangesRequest, GetTvCreditsRequest, GetTvEpisodeGroupDetailsRequest, GetTvGenresRequest, GetTvProvidersRequest, GetUpcomingRequest, GetVideosRequest, GetVideosRequest, GetVideosRequest, GetVideosRequest, GetWatchlistMoviesRequest, GetWatchlistTvRequest, GetWatchProvidersRequest, GetWatchProvidersRequest, GetWatchProvidersRequest, GuestSessionRequestBase, ListRequestBase, MoveListRequestBase, MovieRequestBase, NetworksRequestBase, PaginatedMovieBasedRequest, PaginatedRequestBase, PaginatedSeriesBasedRequest, PaginatedSeriesListBasedRequest, PersonIdAndLanguageRequestBase, PersonIdRequestBase, RegionFilter, RemoveMovieRequest, SearchCollectionsRequest, SearchCompaniesRequest, SearchKeywordsRequest, SearchMoviesRequest, SearchMultiRequest, SearchPeopleRequest, SearchRequestBase, SearchTvRequest, SeasonRequestBase, SeriesRequestBase, WatchProvidersRequestBase, WatchRegionFilter

public interface QueryParameterBasedRequest

Defines a request that contain parameters to be constructed as query parameters in an HTTP request.

Method Summary

Modifier and Type	Method	Description
static okhttp3.HttpUrl.Builder	appendIfNotBlank(okhttp3.HttpUrl.Builder urlBuilder, String name, String value)	Helper method to populate a query parameter if the string value is not blank.
static okhttp3.HttpUrl.Builder	appendIfNotNull(okhttp3.HttpUrl.Builder urlBuilder, String name, Object value)	Helper method to populate a query parameter if the value is not null.
okhttp3.HttpUrl.Builder	populateQueryParameters(okhttp3.HttpUrl.Builder urlBuilder)	Helper method to populate query parameters of a HttpUrl.Builder.

Method Details

populateQueryParameters

okhttp3.HttpUrl.Builder populateQueryParameters(okhttp3.HttpUrl.Builder urlBuilder)

Helper method to populate query parameters of a HttpUrl.Builder.

Parameters:

urlBuilder - the HttpUrl.Builder instance

Returns:

the HttpUrl.Builder instance

appendIfNotNull

static okhttp3.HttpUrl.Builder appendIfNotNull(okhttp3.HttpUrl.Builder urlBuilder,
 String name,
 Object value)

Helper method to populate a query parameter if the value is not null.

Parameters:

urlBuilder - the URL builder

name - the query parameter name

value - the query parameter value

Returns:

the builder

appendIfNotBlank

static okhttp3.HttpUrl.Builder appendIfNotBlank(okhttp3.HttpUrl.Builder urlBuilder,
 String name,
 String value)

Helper method to populate a query parameter if the string value is not blank.

Parameters:

urlBuilder - the URL builder

name - the query parameter name

value - the query parameter value

Returns:

the builder