bosesoundtouchapi.models.introspect

@export
class Introspect(bosesoundtouchapi.soundtouchmodelrequest.SoundTouchModelRequest):

SoundTouch device Introspect configuration object.

This class contains the attributes and sub-items that represent Introspect criteria.

Introspect( source: str = None, sourceAccount: str = None, root: xml.etree.ElementTree.Element = None)

Initializes a new instance of the class.

Arguments:
  • source (str): Type or name of the service to introspect (e.g. "SPOTIFY", "TUNEIN", etc).
  • sourceAccount (str): Account associated with the Source.
  • root (Element): xmltree Element item to load arguments from.
    If specified, then other passed arguments are ignored.
Raises:
  • SoundTouchError: startItem argument was not of type int.
Source: str

Type or name of the service to introspect (e.g. "SPOTIFY", "TUNEIN", etc).

SourceAccount: str

Account associated with the Source.

def ToElement(self, isRequestBody: bool = False) -> xml.etree.ElementTree.Element:

Overridden.
Returns an xmltree Element node representation of the class.

Arguments:
  • isRequestBody (bool): True if the element should only return attributes needed for a POST request body; otherwise, False to return all attributes.
def ToString(self) -> str:

Returns a displayable string representation of the class.