engineer.nightowl.sonos.api.resource

Class MusicServiceAccountsResource

java.lang.Object

engineer.nightowl.sonos.api.resource.MusicServiceAccountsResource

public class MusicServiceAccountsResource
extends Object

Match accounts stored within a household with those on a music service

See Also:

Sonos docs

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
SonosMusicServiceAccount	match(String clientToken, String householdId, SonosMusicServiceAccountMatchRequest request) Match a music service account using provided information.

Methods inherited from class java.lang.Object

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

Constructor Detail

MusicServiceAccountsResource

public MusicServiceAccountsResource(SonosApiClient apiClient)

Constructor for MusicServiceAccountsResource.

Parameters:

apiClient - a SonosApiClient object.

Method Detail

match

public SonosMusicServiceAccount match(String clientToken,
                                      String householdId,
                                      SonosMusicServiceAccountMatchRequest request)
                               throws SonosApiClientException,
                                      SonosApiError

Match a music service account using provided information. Note: untested, as author doesn't have access to SMAPI

Parameters:

clientToken - for the user

householdId - to match accounts with

request - containing the details to match the account

Returns:

a matching SonosMusicServiceAccount if found

Throws:

SonosApiClientException - if an error occurs during the call

SonosApiError - if there is an error from the API

See Also:

Sonos docs