bosesoundtouchapi.models.userrating

@export
class UserRating(bosesoundtouchapi.soundtouchmodelrequest.SoundTouchModelRequest):

SoundTouch device UserRating configuration object.

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

UserRating( rating: bosesoundtouchapi.models.userratingtypes.UserRatingTypes = None, root: xml.etree.ElementTree.Element = None)

Initializes a new instance of the class.

Arguments:
  • rating (str): User rating value to set.
  • root (Element): xmltree Element item to load arguments from.
    If specified, then other passed arguments are ignored.
Rating: str

User Rating value.

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.