bosesoundtouchapi.models.navigateitem

@export

class NavigateItem:

SoundTouch device NavigateItem configuration object.

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

NavigateItem( source: str = None, sourceAccount: str = None, name: str = None, typeValue: str = None, contentItem: bosesoundtouchapi.models.contentitem.ContentItem = None, location: 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).
name (str): Parent container name to navigate, if navigating for child containers.
Specify null if navigating a root container.
typeValue (str): Parent container type to navigate, if navigating for child containers.
Specify null if navigating a root container.
contentItem (ContentItem): Parent container ContentItem to navigate, if navigating for child containers.
Specify null if navigating a root container.
location (str): Parent container location to navigate, if navigating for child containers.
This argument will not be used if the contentItem argument is specified.
root (Element): xmltree Element item to load arguments from.
If specified, then other passed arguments are ignored.

BackupUrl: str

BackupUrl value.

BitRate: str

BitRate value.

ContentItem: bosesoundtouchapi.models.contentitem.ContentItem

Parent container ContentItem to navigate, if navigating for child containers.
Specify null if navigating a root container.

Description: str

Description value.

Format: str

Format value.

Location: str

Location value.

Logo: str

Logo value.

MediaItemContainer: bosesoundtouchapi.models.mediaitemcontainer.MediaItemContainer

MediaItemContainer value.

Mime: str

Mime value.

Name: str

Name value.

Playable: str

Playable value.

Reliability: str

Reliability value.

Token: str

Token value.

TypeValue: str

TypeValue value.

Url: str

Url value.

UtcTime: str

UtcTime value.

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) -> str:

Returns a displayable string representation of the class.