bosesoundtouchapi.models.search

@export

class Search(bosesoundtouchapi.soundtouchmodelrequest.SoundTouchModelRequest):

SoundTouch device Search configuration object.

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

Search( source: str = None, sourceAccount: str = None, searchTerm: bosesoundtouchapi.models.searchterm.SearchTerm = None, containerItem: bosesoundtouchapi.models.navigateitem.NavigateItem = None, startItem: int = None, numItems: int = None, sortType: bosesoundtouchapi.models.searchsorttypes.SearchSortTypes = None, containerTitle: str = None, root: xml.etree.ElementTree.Element = None)

Initializes a new instance of the class.

Arguments:

source (str): Music library source to Search (e.g. "STORED_MUSIC", etc).
sourceAccount (str): Music library source account (e.g. the Music Library user-id).
searchTerm (SearchTerm): Search term object that controls what and how to search for.
containerItem (NavigateItem): Music llibrary container item to search.
startItem (int): Starting item number to return information for.
numItems (int): Number of items to return.
sortType (SearchSortTypes|str): Sort type used by the Music Library to sort the returned items by.
containerTitle (str): Title to assign to the ContainerTitle; also supports formatting - see the ContainerTitleFormatString property for more details.
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.

ContainerItem: bosesoundtouchapi.models.navigateitem.NavigateItem

Music llibrary container item to search.

ContainerTitle: str

Returns formatted container title information for the navigation criteria. Format is controlled by the ContainerTitleFormatString property value.

This allows the caller to easily retrieve (and format) information for display about the current navigation path without having to check for null values.

ContainerTitleFormatString: str

Gets container title format string.

This property controls how the ContainerTitle property value is formatted.

The following keywords are supported:

{source} - Music Library source to navigate.
{sourceaccount} - Music Library source account.
{name} - Name of the container to navigate.
{location} - Location of the container to navigate.

Default is "{name} ({source}, '{sourceaccount}', '{location}')".

NumItems: int

Number of items to return.

SearchTerm: str

Search term object that controls what and how to search for.

SortType: str

Sort type used by the Music Library to sort the returned items by.

Source: str

Music library source to Search (e.g. "STORED_MUSIC", etc).

SourceAccount: str

The account associated with the Source.

StartItem: int

Starting item number to return information for.

StartItem is required, otherwise the search fails.

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.