Interface SessionBasedRequest

All Superinterfaces:

QueryParameterBasedRequest

All Known Implementing Classes:

AccountAndSessionBasedPaginatedRequestBase, AddFavoriteRequest, AddMovieRequest, AddRatingRequest, AddRatingRequest, AddRatingRequest, AddWatchlistRequest, CheckItemStatusRequest, ClearListRequest, CreateListRequest, DeleteListRequest, DeleteRatingRequest, DeleteRatingRequest, DeleteRatingRequest, GetAccountDetailsForSessionRequest, GetAccountDetailsRequest, GetAccountStatesRequest, GetFavoriteMoviesRequest, GetFavoriteTvShowsRequest, GetListsRequest, GetRatedMoviesRequest, GetRatedTvEpisodesRequest, GetRatedTvShowsRequest, GetWatchlistMoviesRequest, GetWatchlistTvRequest, ListRequestBase, RemoveMovieRequest

public interface SessionBasedRequest
extends QueryParameterBasedRequest

Interface that signifies that a request defines a session identifier.

See Also:

• QueryParameterBasedRequest

Method Summary

Modifier and Type	Method	Description
String	getSessionId()	Gets the session identifier.
default okhttp3.HttpUrl.Builder	populateSessionIdQueryParameterIfDefined(okhttp3.HttpUrl.Builder urlBuilder)	Defines the session identifier as a query parameter in the request URL builder if defined.

Methods inherited from interface QueryParameterBasedRequest

populateQueryParameters

Method Details

getSessionId

String getSessionId()

Gets the session identifier.

Returns:

the session identifier

populateSessionIdQueryParameterIfDefined

default okhttp3.HttpUrl.Builder populateSessionIdQueryParameterIfDefined( okhttp3.HttpUrl.Builder urlBuilder)

Defines the session identifier as a query parameter in the request URL builder if defined.

Parameters:

urlBuilder - the URL builder

Returns:

the builder