bosesoundtouchapi.models.searchstationresults

@export
class SearchStationResults:

SoundTouch device SearchStationResults configuration object.

This class contains the attributes and sub-items that represent a single search result item configuration of the device.

SearchStationResults(root: xml.etree.ElementTree.Element)

Initializes a new instance of the class.

Arguments:
  • root (Element): xmltree Element item to load arguments from.
    If specified, then other passed arguments are ignored.
ArtistItems: bosesoundtouchapi.models.searchstationartists.SearchStationArtists

The SearchStationArtists object that contains found artists results.

DeviceId: str

Device identifier the configuration information was obtained from.

SongItems: bosesoundtouchapi.models.searchstationsongs.SearchStationSongs

The SearchStationSongs object that contains found songs results.

Source: str

Music service source where the result was obtained from (e.g. "PANDORA", "SPOTIFY", etc).

SourceAccount: str

The account associated with the Source.

TotalArtistItems: int

The total number of artists in the list.

TotalSongItems: int

The total number of songs in the list.

def ToDictionary(self, encoding: str = 'utf-8') -> dict:

Returns a dictionary representation of the class.

Arguments:
  • encoding (str): encode type (e.g. 'utf-8', 'unicode', etc).
    Default is 'utf-8'.
def ToElement(self, isRequestBody: bool = False) -> xml.etree.ElementTree.Element:

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, includeItems: bool = False) -> str:

Returns a displayable string representation of the class.

Arguments:
  • includeItems (bool): True to include all items in the list; otherwise False to only include the base list.