docs: define ABSDK device name identity
This commit is contained in:
@@ -21,6 +21,7 @@ interface DeviceCatalog {
|
||||
): Flow<DomainResult<List<DeviceDescriptor>>>
|
||||
}
|
||||
|
||||
/** Operates vendor devices by [DeviceName], the identifier accepted by ABSDK 0630. */
|
||||
interface SocketGateway {
|
||||
suspend fun getStatus(
|
||||
profileId: ProviderProfileId,
|
||||
|
||||
@@ -6,6 +6,12 @@ value class ProviderProfileId(val value: String)
|
||||
@JvmInline
|
||||
value class DeviceId(val value: String)
|
||||
|
||||
/**
|
||||
* Vendor-facing device identifier.
|
||||
*
|
||||
* Device names must be unique within the same provider profile and device type because
|
||||
* ABSDK 0630 addresses devices by name rather than by the app's local [DeviceId].
|
||||
*/
|
||||
@JvmInline
|
||||
value class DeviceName(val value: String)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user