engineer.nightowl.sonos.api.resource

Class FavoriteResource

java.lang.Object

engineer.nightowl.sonos.api.resource.FavoriteResource

All Implemented Interfaces:

Subscribable

public class FavoriteResource
extends Object
implements Subscribable

Favorites are 'shortcuts' to playlists, albums, artists etc.

See Also:

Sonos docs, SonosFavorite

Constructor Summary

Constructors

Constructor and Description
FavoriteResource(SonosApiClient apiClient) Constructor for FavoriteResource.

Method Summary

Modifier and Type	Method and Description
SonosFavoriteList	getFavorites(String clientToken, String householdId) Get favorites for the specified household
SonosSuccess	loadFavorite(String clientToken, String groupId, String favoriteId, Boolean playOnCompletion, SonosPlayMode playMode) Activate a favorite in a group
SonosSuccess	subscribe(String clientToken, String householdId) Subscribe to events for this resource.
SonosSuccess	unsubscribe(String clientToken, String householdId) Unsubscribe from events related to this resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FavoriteResource

public FavoriteResource(SonosApiClient apiClient)

Constructor for FavoriteResource.

Parameters:

apiClient - a SonosApiClient object.

Method Detail

getFavorites

public SonosFavoriteList getFavorites(String clientToken,
                                      String householdId)
                               throws SonosApiClientException,
                                      SonosApiError

Get favorites for the specified household

Parameters:

clientToken - for the user

householdId - for the household you want to fetch favorites

Returns:

the favorites for the specified household

Throws:

SonosApiClientException - if an error occurs during the call

SonosApiError - if the API returns an error

See Also:

Sonos docs

loadFavorite

public SonosSuccess loadFavorite(String clientToken,
                                 String groupId,
                                 String favoriteId,
                                 Boolean playOnCompletion,
                                 SonosPlayMode playMode)
                          throws SonosApiClientException,
                                 SonosApiError

Activate a favorite in a group

Parameters:

clientToken - for the user

groupId - to load the favorite in

favoriteId - of the favorite

playOnCompletion - (optional) start playing once loaded

playMode - (optional) provide playback options, where supported

Returns:

if the call was successful

Throws:

SonosApiClientException - if an error occurs during the call.

SonosApiError - if there is an error from the API.

See Also:

Sonos docs

subscribe

public SonosSuccess subscribe(String clientToken,
                              String householdId)
                       throws SonosApiClientException,
                              SonosApiError

Subscribe to events for this resource.

Specified by:

subscribe in interface Subscribable

Parameters:

clientToken - for the user

householdId - of the resource to subscribe to

Returns:

whether the call was successful

Throws:

SonosApiClientException - if an error occurs during the call

SonosApiError - if there is an error from the API

unsubscribe

public SonosSuccess unsubscribe(String clientToken,
                                String householdId)
                         throws SonosApiClientException,
                                SonosApiError

Unsubscribe from events related to this resource.

Specified by:

unsubscribe in interface Subscribable

Parameters:

clientToken - for the user

householdId - of the resource to unsubscribe from

Returns:

whether the call was successful

Throws:

SonosApiClientException - if an error occurs during the call

SonosApiError - if there is an error from the API