Interface AccountBasedRequest

All Superinterfaces:
QueryParameterBasedRequest
All Known Implementing Classes:
AccountAndSessionBasedPaginatedRequestBase, AddFavoriteRequest, AddWatchlistRequest, GetAccountDetailsRequest, GetFavoriteMoviesRequest, GetFavoriteTvShowsRequest, GetListsRequest, GetRatedMoviesRequest, GetRatedTvEpisodesRequest, GetRatedTvShowsRequest, GetWatchlistMoviesRequest, GetWatchlistTvRequest
public interface AccountBasedRequest extends QueryParameterBasedRequest
Interface that signifies that a request requires an account identifier. Note: This is typically used as a path parameter.
See Also:

  • Method Summary

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

    Methods inherited from interface QueryParameterBasedRequest

    populateQueryParameters
    Modifier and Type
    Method
    Description
    okhttp3.HttpUrl.Builder
    populateQueryParameters(okhttp3.HttpUrl.Builder urlBuilder)
    Helper method to populate query parameters of a HttpUrl.Builder.

  • Method Details

    • getAccountId

      int getAccountId()
      Gets the account identifier.
      Returns:
      the account identifier

    • validateAccountId

      default void validateAccountId()
      Validates if the defined account identifier is valid.