Tmdb4ListApi

Functions

Link copied to clipboard
suspend fun addItems(listId: Int, items: Tmdb4ItemsRequest): TmdbStatusResult

This method will let you add items to a list. We support essentially an unlimited number of items to be posted at a time. Both movie and TV series are support. The results of this query will return a results array. Each result includes a success field. If a result is false this will usually indicate that the item already exists on the list. It may also indicate that the item could not be found. You must be the owner of the list and therefore have a valid user access token in order to add items to a list.

Link copied to clipboard
suspend fun checkItemStatus(listId: Int, mediaId: Int, mediaType: TmdbMediaType): Tmdb4ItemStatus

This method lets you quickly check if the item is already added to the list. You must be the owner of the list and therefore have a valid user access token in order to check an item status.

Link copied to clipboard
suspend fun clear(listId: Int): TmdbStatusResult

This method lets you clear all of the items from a list in a single request. This action cannot be reversed so use it with caution. You must be the owner of the list and therefore have a valid user access token in order to clear a list.

Link copied to clipboard

This method will create a new list. You will need to have valid user access token in order to create a new list.

Link copied to clipboard
suspend fun delete(listId: Int): TmdbStatusResult

This method will delete a list by id. This action is not reversible so take care when issuing it. You must be the owner of the list and therefore have a valid user access token in order to delete it.

Link copied to clipboard
suspend fun getList(listId: Int, page: Int, language: String? = null, sortBy: TmdbListSortBy? = null, sortOrder: TmdbSortOrder = TmdbSortOrder.DESC): Tmdb4List

This method will retrieve a list by id. Note: Private lists can only be accessed by their owners and therefore require a valid user access token.

Link copied to clipboard
suspend fun removeItems(listId: Int, items: Tmdb4ItemsRequest): TmdbStatusResult

This method will let you remove items from a list. You can remove multiple items at a time. You must be the owner of the list and therefore have a valid user access token in order to delete items from it.

Link copied to clipboard
suspend fun update(listId: Int, request: Tmdb4UpdateListRequest): TmdbStatusResult

This method will let you update the details of a list. You must be the owner of the list and therefore have a valid user access token in order to edit it.

Link copied to clipboard

This method will let you update an individual item on a list. Currently, only adding a comment is suported. You must be the owner of the list and therefore have a valid user access token in order to edit items.