bosesoundtouchapi.models.searchterm

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

SoundTouch device SearchTerm configuration object.

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

SearchTerm( searchText: str = None, filterType: bosesoundtouchapi.models.searchfiltertypes.SearchFilterTypes = None, root: xml.etree.ElementTree.Element = None)

Initializes a new instance of the class.

Arguments:
  • searchText (str): Text to search for.
  • 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.
FilterType: str

Filter type used by the Music Service to filter the returned items by.

SearchText: str

Text to search for.

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.