thetvdb v1.1.1 TheTVDB.User
This module contains access to all user-scoped endpoints.
All functions allow the user to specify an optional username. If no
username is specified, the last authenticated user will be used. See
TheTVDB
for more information.
Link to this section Summary
Functions
Add a favorite series for a given user
Add a rating for a given user
Get a list of all favorited series for a given user
Get info about a user
Get a list of all ratings for a given user
Remove a favorite series for a given user
Remove a rating for a given user
Link to this section Types
t() :: %TheTVDB.User{favorites_displaymode: term, language: term, user_name: term}
Link to this section Functions
add_favorite(username, integer) :: :ok | {:error, term}
Add a favorite series for a given user.
add_favorite!(username, integer) :: :ok
See add_favorite/2
.
add_rating(username, rating_type, integer, integer) :: :ok | {:error, term}
Add a rating for a given user.
# Rate a series
TheTVDB.User.add_rating(:series, series_id, 10.0)
# => :ok
# Rate an episode
TheTVDB.User.add_rating(:episode, episode_id, 10.0)
# => :ok
# Rate an image
TheTVDB.User.add_rating(:image, image_id, 10.0)
# => :ok
add_rating!(username, rating_type, integer, integer) :: :ok
See add_rating/4
.
favorites(username) :: {:ok, [binary]} | {:error, term}
Get a list of all favorited series for a given user.
See favorites/1
.
Get info about a user.
See info/1
.
Get a list of all ratings for a given user.
See ratings/1
.
remove_favorite(username, integer) :: :ok | {:error, term}
Remove a favorite series for a given user.
remove_favorite!(username, integer) :: :ok
See remove_favorite/2
.
remove_rating(username, rating_type, integer) :: :ok | {:error, term}
Remove a rating for a given user.
remove_rating!(username, rating_type, integer) :: :ok
See remove_rating/3
.