`CustomList`¶

class trakt.objects.list.custom.CustomList(client, keys, user)¶

add(items, **kwargs)¶

Add specified items to the list.

Parameters:	items (`list`) – Items that should be added to the list kwargs (`dict`) – Extra request options
Returns:	Response
Return type:	`dict`

delete(**kwargs)¶

Delete the list.

Parameters:	kwargs (`dict`) – Extra request options
Returns:	Boolean to indicate if the request was successful
Return type:	`bool`

id¶

Retrieve the list identifier.

Return type:	`int`

items(**kwargs)¶

Retrieve list items.

Parameters:	kwargs (`dict`) – Extra request options
Returns:	Current list items
Return type:	`list` of `trakt.objects.media.Media`

like(**kwargs)¶

Like the list.

Parameters:	kwargs (`dict`) – Extra request options
Returns:	Boolean to indicate if the request was successful
Return type:	`bool`

like_count¶

Retrieve the number of likes.

Return type:	`int`

pk¶

Retrieve the primary key (unique identifier for the list).

Returns:	`("trakt", <id>)` or `None` if no primary key is available
Return type:	`tuple`

remove(items, **kwargs)¶

Remove specified items from the list.

Parameters:	items (`list`) – Items that should be removed from the list kwargs (`dict`) – Extra request options
Returns:	Response
Return type:	`dict`

unlike(**kwargs)¶

Un-like the list.

Parameters:	kwargs (`dict`) – Extra request options
Returns:	Boolean to indicate if the request was successful
Return type:	`bool`

update(**kwargs)¶

Update the list with the current object attributes.

Parameters:	kwargs (`dict`) – Extra request options
Returns:	Boolean to indicate if the request was successful
Return type:	`bool`

username¶

Retrieve author username.

Return type:	`str`

trakt.py