\duncan3dc\Sonos\CloudUser

__construct()

__construct(string  $username, \duncan3dc\Sonos\Cloud\Interfaces\ApiInterface  $api, \Psr\SimpleCache\CacheInterface  $cache) 

Create a new instance.

Parameters

isAuthorised()

isAuthorised() : boolean

Check if we have access to this users account.

Returns

getUrl()

getUrl() : string

Get the URL to send the user to for authorisation.

Returns

setCode()

setCode(\duncan3dc\Sonos\Cloud\string  $code) : void

Set the user's authorisation code after redirect.

Parameters

request()

request(\duncan3dc\Sonos\Cloud\string  $method, \duncan3dc\Sonos\Cloud\string  $url, array  $data = array()) 

Parameters

getHouseholds()

getHouseholds() : \duncan3dc\Sonos\Cloud\Interfaces\iterable|array<mixed,\duncan3dc\Sonos\Cloud\Interfaces\HouseholdInterface>

Get all the households this user has access to.

Returns

getHousehold()

getHousehold(\duncan3dc\Sonos\Cloud\string  $id) : \duncan3dc\Sonos\Cloud\Interfaces\HouseholdInterface

Get a household this user has access to.

Parameters

Returns

getToken()

getToken() : \League\OAuth2\Client\Token\AccessToken

Get the access token for this user.

Returns