Class AccountAndSessionBasedPaginatedRequestBase

java.lang.Object

com.amilesend.tmdb.client.model.acount.type.PaginatedRequestBase

com.amilesend.tmdb.client.model.acount.type.AccountAndSessionBasedPaginatedRequestBase

All Implemented Interfaces:

AccountBasedRequest, QueryParameterBasedRequest, SessionBasedRequest

Direct Known Subclasses:

GetFavoriteMoviesRequest, GetFavoriteTvShowsRequest, GetRatedMoviesRequest, GetRatedTvEpisodesRequest, GetRatedTvShowsRequest, GetWatchlistMoviesRequest, GetWatchlistTvRequest

public abstract class AccountAndSessionBasedPaginatedRequestBase
extends PaginatedRequestBase
implements AccountBasedRequest, SessionBasedRequest

The request to retrieve paginated session-based resources that is associated with an account.

See Also:

• AccountApi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AccountAndSessionBasedPaginatedRequestBase.AccountAndSessionBasedPaginatedRequestBaseBuilder<C extends AccountAndSessionBasedPaginatedRequestBase, B extends AccountAndSessionBasedPaginatedRequestBase.AccountAndSessionBasedPaginatedRequestBaseBuilder<C,B>>

Nested classes/interfaces inherited from class PaginatedRequestBase

PaginatedRequestBase.PaginatedRequestBaseBuilder<C,B>

Modifier and Type	Class	Description
static class	PaginatedRequestBase.PaginatedRequestBaseBuilder<C extends PaginatedRequestBase, B extends PaginatedRequestBase.PaginatedRequestBaseBuilder<C,B>>

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	getAccountId()	The account identifier (required).
String	getSessionId()	The session identifier that is authorized to access the account information (optional).
int	hashCode()
okhttp3.HttpUrl.Builder	populateQueryParameters(okhttp3.HttpUrl.Builder urlBuilder)	Helper method to populate query parameters of a HttpUrl.Builder.
String	toString()

Methods inherited from class PaginatedRequestBase

getLanguage, getPage, getSortBy

Modifier and Type	Method	Description
String	getLanguage()	The language to filter the resources on.
Integer	getPage()	The page number (must be > 0).
SortBy	getSortBy()	Sort by option.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface AccountBasedRequest

validateAccountId

Modifier and Type	Method	Description
default void	validateAccountId()	Validates if the defined account identifier is valid.

Methods inherited from interface SessionBasedRequest

populateSessionIdQueryParameterIfDefined

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

Method Details

populateQueryParameters

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

Description copied from interface: QueryParameterBasedRequest

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

Specified by:

populateQueryParameters in interface QueryParameterBasedRequest

Overrides:

populateQueryParameters in class PaginatedRequestBase

Parameters:

urlBuilder - the HttpUrl.Builder instance

Returns:

the HttpUrl.Builder instance

getAccountId

public int getAccountId()

The account identifier (required).

Specified by:

getAccountId in interface AccountBasedRequest

Returns:

the account identifier

getSessionId

public String getSessionId()

The session identifier that is authorized to access the account information (optional).

Specified by:

getSessionId in interface SessionBasedRequest

Returns:

the session identifier

equals

public boolean equals(Object o)

Overrides:

equals in class PaginatedRequestBase

hashCode

public int hashCode()

Overrides:

hashCode in class PaginatedRequestBase

toString

public String toString()

Overrides:

toString in class PaginatedRequestBase