bosesoundtouchapi.soundtouchmessage
@export
class
SoundTouchMessage:
A class representing an exchange object.
In order to exchange data between a client and the device, this class type is used. It stores the request text/uri and the response as an XML- Element.
SoundTouchMessage( uri: bosesoundtouchapi.uri.soundtouchuri.SoundTouchUri = None, xmlMessage: str = None, response: xml.etree.ElementTree.Element = None)
Initializes a new instance of the class.
Arguments:
- uri (SoundTouchUri): The target uri which should be queried.
- xmlMessage (str): If a key should be pressed or new data should be saved on the target device, an xml formatted string is needed.
- response (xml.etree.ElementTree.Element): The response object as an XML-Element.
HasXmlMessage: bool
Returns True if an xml message was returned with the response; otherwise, False.
IsSimpleResponse: bool
Returns True if the response is a simple pass / fail response; otherwise, False if the response requires further processing.