Kotlin: IamUtil.awaitPairLocalOpen()

DESCRIPTION

Perform Local Open pairing, requesting the specified username.

Local open pairing uses the trusted local network (LAN) pairing mechanism. No password is required for pairing and no invitation is needed, anybody on the LAN can initiate pairing.

This function is meant to be used in a Kotlin coroutine to suspend execution until the operation has completed.

Read more here: https://docs.nabto.com/developer/guides/iam/pairing.html#open-local

DECLARATION

suspend fun IamUtil.awaitPairLocalOpen(
    connection: Connection,
    desiredUsername: String,
) 

PARAMETERS

connection:

An established connection to the device this client should be paired with

desiredUsername:

Assign this username on the device if available (pairing fails with .USERNAME_EXISTS if not)

THROWS EXCEPTIONS

USERNAME_EXISTS:

if desiredUsername is already in use on the device

INVALID_INPUT:

if desiredUsername is not valid as per https://docs.nabto.com/developer/api-reference/coap/iam/post-users.html#request

BLOCKED_BY_DEVICE_CONFIGURATION:

if the device configuration does not support local open pairing (the IAM:PairingLocalOpen action is not set for the Unpaired role or the device does not support the pairing mode at all)

PAIRING_MODE_DISABLED:

if the pairing mode is configured on the device but is disabled at runtime

IAM_NOT_SUPPORTED:

if Nabto Edge IAM is not supported by the device