bosesoundtouchapi.models.navigate

@export

class Navigate(bosesoundtouchapi.soundtouchmodelrequest.SoundTouchModelRequest):

SoundTouch device Navigate configuration object.

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

Navigate( source: str = None, sourceAccount: str = None, containerItem: bosesoundtouchapi.models.navigateitem.NavigateItem = None, startItem: int = None, numItems: int = None, sortType: bosesoundtouchapi.models.navigatesorttypes.NavigateSortTypes = None, menuType: bosesoundtouchapi.models.navigatemenutypes.NavigateMenuTypes = None, containerTitle: str = None, root: xml.etree.ElementTree.Element = None)

Initializes a new instance of the class.

Arguments:

source (str): Music service source to navigate (e.g. "PANDORA", "STORED_MUSIC", etc).
sourceAccount (str): Music service source account (e.g. the music service user-id).
containerItem (NavigateItem): Music service container item to navigate, if searching for child items.
Specify null to navigate the root container.
startItem (int): Starting item number to return information for.
numItems (int): Number of items to return.
sortType (NavigateSortTypes|str): Sort type used by the Music Service to sort the returned items by.
menuType (NavigateMenuTypes|str): Music service menu type to navigate (e.g. "radioStations", etc).
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: str

Music service container item to navigate, if searching for child items.

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 service source to navigate.
{sourceaccount} - Music service source account.
{name} - Name of the container to navigate.
{location} - Location of the container to navigate.

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

Description: str

Description attribute value.

Language: str

Language attribute value.

LocalTime: str

LocalTime attribute value.

MenuType: str

Music service menu type to navigate (e.g. "radioStations", etc).

NumItems: int

Number of items to return.

SortType: str

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

Source: str

Music service source to navigate (e.g. "PANDORA", "SPOTIFY", etc).

SourceAccount: str

The account associated with the Source.

StartItem: int

Starting item number to return information 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.