bosesoundtouchapi.models.searchstation
SoundTouch device SearchStation configuration object.
This class contains the attributes and sub-items that represent SearchStation criteria.
SearchStation( source: str = None, sourceAccount: str = None, searchText: str = None, sortType: bosesoundtouchapi.models.searchsorttypes.SearchSortTypes = None, filterType: bosesoundtouchapi.models.searchfiltertypes.SearchFilterTypes = None, root: xml.etree.ElementTree.Element = None)
Initializes a new instance of the class.
Arguments:
- source (str): Music service source to search (e.g. "PANDORA", "SPOTIFY", etc).
- sourceAccount (str): Music service source account (e.g. the music service user-id).
- searchText (str): Text to search for in the Music service.
- sortType (SearchSortTypes|str): Sort type used by the Music Service to sort the returned items by.
- filterType (SearchFilterTypes|str): Filter type used by the Music Service to filter the returned items by.
- 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.
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.