bosesoundtouchapi.soundtoucherror

@export
class SoundTouchError(builtins.Exception):

Exception thrown when a SoundTouch device returns an error status for a command.

SoundTouchError( message: str, name: str = None, severity: str = None, errorCode: int = 0, logsi: smartinspectpython.sisession.SISession = None)

Initializes a new class instance using specified message text.

Arguments:
  • message (str): Message text, as reported by the element text of the error xml response.
  • name (str): Name value, as reported by the "name" attribute of the error xml response.
  • severity (str): Severity value, as reported by the "severity" attribute of the error xml response.
  • errorCode (int): Error code value, as reported by the "value" attribute of the error xml response.
  • logsi (SISession): Trace session object that this exception will be logged to, or null to bypass trace logging.
    Default is None.
ErrorCode: int

Error code value, as reported by the "value" attribute of the error xml response.

Examples: "401", "415", etc.

Message: str

Message text, as reported by the element text of the error xml response.

Name: str

Name value, as reported by the "name" attribute of the error xml response.

Examples: "HTTP_STATUS_UNAUTHORIZED", "HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE", etc.

Severity: str

Severity value, as reported by the "severity" attribute of the error xml response.

Examples: "Unknown"

def ToString(self) -> str:

Returns a displayable string representation of the class.