core/io.github.easynearby.core.connection/ConnectionCandidate

ConnectionCandidate

data class ConnectionCandidate(val id: String, val name: String, authenticationDigits: String?)

Connection candidate that represents a remote device. isIncomingConnection is used to distinguish between connections intitiated by this app and connections initiated by other apps.

Constructors

ConnectionCandidate

constructor(id: String, name: String, authenticationDigits: String?)

Properties

val id: String

isIncomingConnection

val isIncomingConnection: Boolean

Authentication digits are only available for incoming connections

name

val name: String

Functions

connect

suspend fun connect(localDeviceName: String, authValidator: suspend (String) -> Boolean = { true }): Result<Connection>

Tries to connect to the remote endpoint and returns a Connection if result is successful