lib/app.moviebase.trakt.api/TraktUsersApi

TraktUsersApi

class TraktUsersApi(client: HttpClient)

Constructors

TraktUsersApi

constructor(client: HttpClient)

Functions

addFavorites

suspend fun addFavorites(items: TraktSyncItems): TraktSyncResponse

Add items to a user's favorites.

addHiddenItems

suspend fun addHiddenItems(section: TraktHiddenSection, items: TraktSyncItems): TraktSyncResponse

addListItems

suspend fun addListItems(userSlug: TraktUserSlug = TraktUserSlug.ME, listId: String, items: TraktSyncItems): TraktSyncResponse

approveFollowRequest

suspend fun approveFollowRequest(requestId: Int): TraktFollowResponse

createList

suspend fun createList(userSlug: TraktUserSlug = TraktUserSlug.ME, list: TraktList): TraktList

deleteList

suspend fun deleteList(userSlug: TraktUserSlug = TraktUserSlug.ME, listId: String): HttpResponse

denyFollowRequest

suspend fun denyFollowRequest(requestId: Int): HttpResponse

suspend fun follow(userSlug: TraktUserSlug): TraktFollowResponse

getCollectionMovies

suspend fun getCollectionMovies(userSlug: TraktUserSlug, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktCollectionItem>

getCollectionShows

suspend fun getCollectionShows(userSlug: TraktUserSlug, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktCollectionItem>

getFavoriteMovies

suspend fun getFavoriteMovies(userSlug: TraktUserSlug = TraktUserSlug.ME, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktFavoriteItem>

Get a user's favorite movies.

getFavoriteShows

suspend fun getFavoriteShows(userSlug: TraktUserSlug = TraktUserSlug.ME, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktFavoriteItem>

Get a user's favorite shows.

getFollowerRequests

suspend fun getFollowerRequests(extended: TraktExtended? = null): List<TraktFollowRequest>

getFollowers

suspend fun getFollowers(userSlug: TraktUserSlug, extended: TraktExtended? = null): List<TraktUser>

getFollowing

suspend fun getFollowing(userSlug: TraktUserSlug, extended: TraktExtended? = null): List<TraktUser>

getFriends

suspend fun getFriends(userSlug: TraktUserSlug, extended: TraktExtended? = null): List<TraktUser>

getHiddenItems

suspend fun getHiddenItems(section: TraktHiddenSection, type: TraktMediaType? = null, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktHiddenItem>

getHiddenItemsPage

suspend fun getHiddenItemsPage(section: TraktHiddenSection, type: TraktMediaType? = null, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): TraktPage<TraktHiddenItem>

getHistory

suspend fun getHistory(userSlug: TraktUserSlug = TraktUserSlug.ME, listType: TraktListMediaType? = null, itemId: Int? = null, extended: TraktExtended? = null, startAt: Instant? = null, endAt: Instant? = null, page: Int? = null, limit: Int? = null): List<TraktHistoryItem>

Example: users/id/history/type/item_id?start_at=2016-06-01T00%3A00%3A00.000Z&end_at=2016-07-01T23%3A59%3A59.000Z

getHistoryPage

suspend fun getHistoryPage(userSlug: TraktUserSlug = TraktUserSlug.ME, listType: TraktListMediaType? = null, itemId: Int? = null, extended: TraktExtended? = null, startAt: Instant? = null, endAt: Instant? = null, page: Int? = null, limit: Int? = null): TraktPage<TraktHistoryItem>

getLikes

suspend fun getLikes(type: String? = null, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS): List<TraktLike>

getListItems

suspend fun getListItems(userSlug: TraktUserSlug = TraktUserSlug.ME, listId: String, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktUserListItem>

getListItemsPage

suspend fun getListItemsPage(userSlug: TraktUserSlug = TraktUserSlug.ME, listId: String, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): TraktPage<TraktUserListItem>

getLists

suspend fun getLists(userSlug: TraktUserSlug = TraktUserSlug.ME): List<TraktList>

getProfile

suspend fun getProfile(userSlug: TraktUserSlug, extended: TraktExtended? = null): TraktUser

getRatingsEpisodes

suspend fun getRatingsEpisodes(userSlug: TraktUserSlug = TraktUserSlug.ME, rating: Int? = null, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktRatedItem>

Get a user's ratings for episodes.

getRatingsMovies

suspend fun getRatingsMovies(userSlug: TraktUserSlug = TraktUserSlug.ME, rating: Int? = null, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktRatedItem>

Get a user's ratings for movies.

getRatingsSeasons

suspend fun getRatingsSeasons(userSlug: TraktUserSlug = TraktUserSlug.ME, rating: Int? = null, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktRatedItem>

Get a user's ratings for seasons.

getRatingsShows

suspend fun getRatingsShows(userSlug: TraktUserSlug = TraktUserSlug.ME, rating: Int? = null, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktRatedItem>

Get a user's ratings for shows.

getSettings

suspend fun getSettings(): TraktUserSettings

getStats

suspend fun getStats(userSlug: TraktUserSlug): TraktUser

getUserNotes

suspend fun getUserNotes(userSlug: TraktUserSlug, type: String? = null, page: Int? = null, limit: Int? = null): List<TraktNoteItem>

getUserNotesPage

suspend fun getUserNotesPage(userSlug: TraktUserSlug, type: String? = null, page: Int? = null, limit: Int? = null): TraktPage<TraktNoteItem>

getWatchedMovies

suspend fun getWatchedMovies(userSlug: TraktUserSlug, extended: TraktExtended? = null): List<TraktWatchedItem>

getWatchedShows

suspend fun getWatchedShows(userSlug: TraktUserSlug, extended: TraktExtended? = null): List<TraktWatchedItem>

getWatching

suspend fun getWatching(userSlug: TraktUserSlug = TraktUserSlug.ME, extended: TraktExtended? = null): TraktWatching?

getWatchlistEpisodes

suspend fun getWatchlistEpisodes(userSlug: TraktUserSlug = TraktUserSlug.ME, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktWatchlistItem>

Get a user's watchlist episodes.

getWatchlistMovies

suspend fun getWatchlistMovies(userSlug: TraktUserSlug = TraktUserSlug.ME, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktWatchlistItem>

Get a user's watchlist movies.

getWatchlistSeasons

suspend fun getWatchlistSeasons(userSlug: TraktUserSlug = TraktUserSlug.ME, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktWatchlistItem>

Get a user's watchlist seasons.

getWatchlistShows

suspend fun getWatchlistShows(userSlug: TraktUserSlug = TraktUserSlug.ME, page: Int = 1, limit: Int = TraktWebConfig.MAX_LIMIT_ITEMS, extended: TraktExtended? = null): List<TraktWatchlistItem>

Get a user's watchlist shows.

removeFavorites

suspend fun removeFavorites(items: TraktSyncItems): TraktSyncResponse

Remove items from a user's favorites.

removeHiddenItems

suspend fun removeHiddenItems(section: TraktHiddenSection, items: TraktSyncItems): TraktSyncResponse

removeListItems

suspend fun removeListItems(userSlug: TraktUserSlug = TraktUserSlug.ME, listId: String, items: TraktSyncItems): TraktSyncResponse

unfollow

suspend fun unfollow(userSlug: TraktUserSlug): HttpResponse

updateList

suspend fun updateList(userSlug: TraktUserSlug = TraktUserSlug.ME, listId: String, list: TraktList): TraktList