bosesoundtouchapi.models.navigateresponse

@export

class NavigateResponse:

SoundTouch device NavigateResponse configuration object.

This class contains the attributes and sub-items that represent the navigate response configuration of the device.

NavigateResponse(root: xml.etree.ElementTree.Element = None)

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.

ItemCount: int

The number of items in the Items list.

Note that this could be different than the TotalItems property if the user is limiting the returned results.

Items: list[bosesoundtouchapi.models.navigateitem.NavigateItem]

The list of NavigateItem items.

Source: str

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

SourceAccount: str

The account associated with the Source.

SourceTitle: str

The source title of media content (e.g. "Pandora (userid)", etc).

This property is not part of the returned xml of the configuration, but is set after a call to SoundTouchClient.GetMusicServiceStations and SoundTouchClient.GetMusicLibraryItems so that the source title can be displayed by user-interfaces.

TotalItems: int

The total number of items in the list, as reported by the music service.

def GetItemByName(self, name: str) -> bosesoundtouchapi.models.navigateitem.NavigateItem:

Searches the items collection for an item with the specified Name and returns the matching item if found; otherwise, None is returned.

Arguments:

name (str): Name value to search for (case-sensitive).

def ContainsLocation( self, source: str, location: str) -> bosesoundtouchapi.models.navigateitem.NavigateItem:

Searches the items collection for an item with the specified Source and ContentItem.Location property values and returns the item if found; otherwise, None is returned.

Arguments:

source (str): Music Service Source value to search for.
location (str): ContentItem.Location value to search for.

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.