bosesoundtouchapi.models.recentlist

@export
class RecentList:

SoundTouch device RecentList configuration object.

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

The list of Recent objects are sorted by CreatedOn in descending order so that the last entry added to the recents list is the first to appear in the list.

RecentList(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.
LastUpdatedOn: int

Date and time (in epoch format) of when the recent list was last updated.

This is a helper property, and is not part of the SoundTouch WebServices API implementation.

Recents: list[bosesoundtouchapi.models.recent.Recent]

The list of Recent items.

def ContainsName(self, source: str, name: str) -> bosesoundtouchapi.models.recent.Recent:

Checks the list items for a matching source and name value.

Arguments:
  • source (str): Source to find in the list.
  • name (str): Name to find in the list.
Returns:

A Recent instance if the name was found; otherwise, null.

def IndexOfName(self, source: str, name: str) -> bosesoundtouchapi.models.recent.Recent:

Returns the index of the list item matching the source and name value.

Arguments:
  • source (str): Source to find in the list.
  • name (str): Name to find in the list.
Returns:

The index of the item if found; otherwise, -1.

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.
def ToXmlString(self, encoding: str = 'utf-8') -> str:

Returns an xml string representation of the class.

Arguments:
  • encoding (str): encode type (e.g. 'utf-8', 'unicode', etc).
    Default is 'utf-8'.