bosesoundtouchapi.uri.soundtouchuri

@export
class SoundTouchUri:

A SoundTouchUri object can be used in several ways. Since, the object can not be edited, there is no editing available.

The __str__ and __repr__ method will return the assigned path name (created when initiating a new instance).

SoundTouchUri( path: str, scope: bosesoundtouchapi.uri.soundtouchuriscopes.SoundTouchUriScopes = <SoundTouchUriScopes.OP_SCOPE_PUBLIC: 0>, uriType: bosesoundtouchapi.uri.soundtouchuritypes.SoundTouchUriTypes = <SoundTouchUriTypes.OP_TYPE_REQUEST: 8>)

Initializes a new instance of the class.

Arguments:
  • path (str): The target uri which will be formatted into the url in a request.
  • scope (SoundTouchUriScope): The scope of this URI object. If it is private, the client may not request the resource.
  • uriType (SoundTouchUriType): Defines the type of this uri; it can be either 'request' or 'event'.
Path: str

The target uri which will be formatted into the url in a request.

Scope: str

The scope of this URI object. If it is private, the client may not request the resource.

UriType: str

Defines the type of this uri; it can be either 'request' or 'event'.

def ToString(self) -> str:

Returns a displayable string representation of the class.