engineer.nightowl.sonos.api.specs

Interface Subscribable

All Known Implementing Classes:

FavoriteResource, GroupResource, GroupVolumeResource, PlaybackMetadataResource, PlaybackResource, PlaybackSessionResource, PlayerVolumeResource

public interface Subscribable

Subscribable interface.

Method Summary

Modifier and Type	Method and Description
SonosSuccess	subscribe(String clientToken, String resourceId) Subscribe to events for this resource.
SonosSuccess	unsubscribe(String clientToken, String resourceId) Unsubscribe from events related to this resource.

Method Detail

subscribe

SonosSuccess subscribe(String clientToken,
                       String resourceId)
                throws SonosApiClientException,
                       SonosApiError

Subscribe to events for this resource.

Parameters:

clientToken - for the user

resourceId - 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

SonosSuccess unsubscribe(String clientToken,
                         String resourceId)
                  throws SonosApiClientException,
                         SonosApiError

Unsubscribe from events related to this resource.

Parameters:

clientToken - for the user

resourceId - 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