Class AddFavoriteRequest

java.lang.Object

com.amilesend.tmdb.client.model.acount.AddFavoriteRequest

All Implemented Interfaces:

AccountBasedRequest, BodyBasedRequest, QueryParameterBasedRequest, SessionBasedRequest

public class AddFavoriteRequest
extends Object
implements BodyBasedRequest, AccountBasedRequest, SessionBasedRequest

Defines the attributes when adding or removing a favorite for an account.

See Also:

• BodyBasedRequest
• AccountBasedRequest
• SessionBasedRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AddFavoriteRequest.AddFavoriteRequestBuilder

Method Summary

Modifier and Type	Method	Description
static AddFavoriteRequest.AddFavoriteRequestBuilder	builder()
boolean	equals(Object o)
int	getAccountId()	The account identifier (required).
int	getMediaId()	The unique media identifier (required).
String	getMediaType()	The media type (i.e., "movie" or "tv", required)
String	getSessionId()	The session identifier (optional).
int	hashCode()
boolean	isFavorite()	When true, the media is added as a favorite; else false, removes the media as a favorite (required).
okhttp3.HttpUrl.Builder	populateQueryParameters(okhttp3.HttpUrl.Builder urlBuilder)	Helper method to populate query parameters of a HttpUrl.Builder.
String	toString()

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

Parameters:

urlBuilder - the HttpUrl.Builder instance

Returns:

the HttpUrl.Builder instance

builder

public static AddFavoriteRequest.AddFavoriteRequestBuilder builder()

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 (optional).

Specified by:

getSessionId in interface SessionBasedRequest

Returns:

the session identifier

getMediaType

public String getMediaType()

The media type (i.e., "movie" or "tv", required)

getMediaId

public int getMediaId()

The unique media identifier (required).

isFavorite

public boolean isFavorite()

When true, the media is added as a favorite; else false, removes the media as a favorite (required).

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object