engineer.nightowl.sonos.api.domain

Class SonosSessionRequest

java.lang.Object

engineer.nightowl.sonos.api.domain.SonosSessionRequest

All Implemented Interfaces:

Validatable

public class SonosSessionRequest
extends Object
implements Validatable

SonosSessionRequest class.

Constructor Summary

Constructors

Constructor and Description
SonosSessionRequest() Constructor for SonosSessionRequest.
SonosSessionRequest(String accountId, String appContext, String appId, String customData) Constructor for SonosSessionRequest.

Method Summary

Modifier and Type	Method and Description
String	getAccountId() Getter for the field accountId.
String	getAppContext() Getter for the field appContext.
String	getAppId() Getter for the field appId.
String	getCustomData() Getter for the field customData.
void	setAccountId(String accountId) Setter for the field accountId.
void	setAppContext(String appContext) Setter for the field appContext.
void	setAppId(String appId) Setter for the field appId.
void	setCustomData(String customData) Setter for the field customData.
String	toString()
void	validate() Hook to validate an object

Methods inherited from class java.lang.Object

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

Methods inherited from interface engineer.nightowl.sonos.api.specs.Validatable

isValid

Constructor Detail

SonosSessionRequest

public SonosSessionRequest()

Constructor for SonosSessionRequest.

SonosSessionRequest

public SonosSessionRequest(String accountId,
                           String appContext,
                           String appId,
                           String customData)

Constructor for SonosSessionRequest.

Parameters:

accountId - a String object.

appContext - a String object.

appId - a String object.

customData - a String object.

Method Detail

getAccountId

public String getAccountId()

Getter for the field accountId.

Returns:

a String object.

setAccountId

public void setAccountId(String accountId)

Setter for the field accountId.

Parameters:

accountId - a String object.

getAppContext

public String getAppContext()

Getter for the field appContext.

Returns:

a String object.

setAppContext

public void setAppContext(String appContext)

Setter for the field appContext.

Parameters:

appContext - a String object.

getAppId

public String getAppId()

Getter for the field appId.

Returns:

a String object.

setAppId

public void setAppId(String appId)

Setter for the field appId.

Parameters:

appId - a String object.

getCustomData

public String getCustomData()

Getter for the field customData.

Returns:

a String object.

setCustomData

public void setCustomData(String customData)

Setter for the field customData.

Parameters:

customData - a String object.

toString

public String toString()

Overrides:

toString in class Object

validate

public void validate()
              throws SonosApiClientException

Hook to validate an object

Validate this request before sending, to avoid a needless API call.

As per documentation, only appId and appContext are required for joining or creating a session request.

Specified by:

validate in interface Validatable

Throws:

SonosApiClientException - if there are validation errors