public class SonosApiClient extends Object
| Constructor and Description |
|---|
SonosApiClient(SonosApiConfiguration configuration)
Main client for Sonos API.
|
| Modifier and Type | Method and Description |
|---|---|
AuthorizeResource |
authorize()
Authorization methods to connect a user with the Sonos API.
|
void |
closeHttpClient()
Close the HTTP client.
|
FavoriteResource |
favorite()
Manage a household's favorites.
|
SonosApiConfiguration |
getConfiguration()
Get the configured options for this client.
|
org.apache.http.impl.client.CloseableHttpClient |
getHttpClient()
Get the configured HTTP client for this API client instance.
|
GroupResource |
group()
Manage a household's groups.
|
GroupVolumeResource |
groupVolumeResource()
Manage the volume of a group
|
HomeTheaterResource |
homeTheater()
Manage home theater features
|
HouseholdResource |
household()
Manage a user's household(s)
|
MusicServiceAccountsResource |
musicServiceAccounts()
Match music service accounts
|
PlaybackResource |
playback()
Manage the playback of the system.
|
PlaybackMetadataResource |
playbackMetadata()
Subscribe/unsubscribe to playback events
|
PlaybackSessionResource |
playbackSession()
Manage playback sessions.
|
PlayerVolumeResource |
playerVolume()
Manage player volume.
|
void |
setConfiguration(SonosApiConfiguration configuration)
Set a new
SonosApiConfiguration. |
void |
setHttpClient(org.apache.http.impl.client.CloseableHttpClient httpClient)
Set a custom HTTP client.
|
public SonosApiClient(SonosApiConfiguration configuration)
configuration - - a SonosApiConfiguration containing integration
information such as API keyspublic void closeHttpClient()
public org.apache.http.impl.client.CloseableHttpClient getHttpClient()
public void setHttpClient(org.apache.http.impl.client.CloseableHttpClient httpClient)
httpClient - custom client to setpublic SonosApiConfiguration getConfiguration()
public void setConfiguration(SonosApiConfiguration configuration)
SonosApiConfiguration.configuration - - the new SonosApiConfigurationpublic AuthorizeResource authorize()
public FavoriteResource favorite()
public GroupResource group()
public GroupVolumeResource groupVolumeResource()
public HomeTheaterResource homeTheater()
public HouseholdResource household()
public MusicServiceAccountsResource musicServiceAccounts()
public PlaybackMetadataResource playbackMetadata()
public PlaybackResource playback()
public PlaybackSessionResource playbackSession()
public PlayerVolumeResource playerVolume()
Copyright © 2018. All rights reserved.