engineer.nightowl.sonos.api.resource

Class HouseholdResource

java.lang.Object

engineer.nightowl.sonos.api.resource.HouseholdResource

public class HouseholdResource
extends Object

A Household represents a parent object containing a number of players/groups, and favorites.

See Also:

Sonos docs, SonosHousehold

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
SonosHouseholdList	getHouseholds(String clientToken) Get a user's households.

Methods inherited from class java.lang.Object

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

Constructor Detail

HouseholdResource

public HouseholdResource(SonosApiClient apiClient)

Constructor for HouseholdResource.

Parameters:

apiClient - a SonosApiClient object.

Method Detail

getHouseholds

public SonosHouseholdList getHouseholds(String clientToken)
                                 throws SonosApiClientException,
                                        SonosApiError

Get a user's households.

Parameters:

clientToken - for the user

Returns:

SonosHouseholdList containing a nested list of households.

Throws:

SonosApiClientException - if an error occurs during the call.

SonosApiError - if there is an error from the API

See Also:

Sonos docs