SOLUTION
DEVELOPER
CASES
PARTNERS
PRICING
BLOG
Try now
Login
Documentation
Edge Guides
Edge Platforms
Edge API Reference
ANDROID
Android Client SDK
Introduction
NabtoClient class
NabtoClient
NabtoClient.create
NabtoClient.setLogLevel
NabtoClient.createPrivateKey
NabtoClient.createConnection
NabtoClient.createMdnsScanner
NabtoClient.addMdnsResultListener
NabtoClient.removeMdnsResultListener
NabtoClient.version
NabtoClient.close
Connection interface
Connection
Connection.Type
Connection.updateOptions
Connection.getOptions
Connection.getDeviceFingerprint
Connection.getClientFingerprint
Connection.getType
Connection.enableDirectCandidates
Connection.addDirectCandidate
Connection.endOfDirectCandidates
Connection.createStream
Connection.createCoap
Connection.createTcpTunnel
Connection.connectionClose
Connection.connectionCloseCallback
Connection.close
Connection.connect
Connection.connectCallback
Connection.getLocalChannelErrorCode
Connection.getRemoteChannelErrorCode
Connection.getDirectCandidatesChannelErrorCode
Connection.passwordAuthenticate
Connection.passwordAuthenticateCallback
Connection.addConnectionEventsListener
Connection.removeConnectionEventsListener
Kotlin: Connection.awaitConnectionClose
Kotlin: Connection.awaitConnect
ConnectionEventsCallback class
ConnectionEventsCallback
ConnectionEventsCallback.onEvent
MdnsScanner interface
MdnsScanner
MdnsScanner.start
MdnsScanner.stop
MdnsScanner.isStarted
MdnsScanner.addMdnsResultReceiver
MdnsScanner.removeMdnsResultReceiver
MdnsResult interface
MdnsResult
MdnsResult.Action
MdnsResult.getDeviceId
MdnsResult.getProductId
MdnsResult.getServiceInstanceName
MdnsResult.getTxtItems
MdnsResult.getAction
MdnsResultListener interface
MdnsResultListener
MdnsResultListener.onChange
Coap interface
Coap
Coap.ContentFormat
Coap.ContentFormat.TEXT_PLAIN
Coap.ContentFormat.APPLICATION_XML
Coap.ContentFormat.APPLICATION_OCTET_STREAM
Coap.ContentFormat.APPLICATION_CBOR
Coap.setRequestPayload
Coap.execute
Coap.executeCallback
Coap.getResponseStatusCode
Coap.getResponseContentFormat
Coap.getResponsePayload
Coap.close
Kotlin: Coap.awaitExecute
Stream interface
Stream
Stream.open
Stream.openCallback
Stream.readSome
Stream.readSomeCallback
Stream.readAll
Stream.readAllCallback
Stream.write
Stream.writeCallback
Stream.streamClose
Stream.streamCloseCallback
Stream.close
Stream.abort
Kotlin: Stream.awaitOpen
Kotlin: Stream.awaitReadSome
Kotlin: Stream.awaitReadAll
Kotlin: Stream.awaitWrite
Kotlin: Stream.awaitStreamClose
TcpTunnel interface
TcpTunnel
TcpTunnel.open
TcpTunnel.openCallback
TcpTunnel.tunnelCloseCallback
TcpTunnel.getLocalPort
TcpTunnel.tunnelClose
TcpTunnel.close
Kotlin: TcpTunnel.awaitOpen
Kotlin: TcpTunnel.awaitTunnelClose
ErrorCode class
ErrorCode
ErrorCode.getDescription
ErrorCode.getName
ErrorCode.getErrorCode
ErrorCodes class
ErrorCodes
ErrorCodes.OK
ErrorCodes.ABORTED
ErrorCodes.BAD_RESPONSE
ErrorCodes.CLOSED
ErrorCodes.DNS
ErrorCodes.END_OF_FILE
ErrorCodes.FORBIDDEN
ErrorCodes.FUTURE_NOT_RESOLVED
ErrorCodes.INVALID_ARGUMENT
ErrorCodes.INVALID_STATE
ErrorCodes.NOT_CONNECTED
ErrorCodes.NOT_FOUND
ErrorCodes.NOT_IMPLEMENTED
ErrorCodes.NO_CHANNELS
ErrorCodes.NO_DATA
ErrorCodes.OPERATION_IN_PROGRESS
ErrorCodes.PARSE
ErrorCodes.PORT_IN_USE
ErrorCodes.STOPPED
ErrorCodes.TIMEOUT
ErrorCodes.UNKNOWN
ErrorCodes.NONE
ErrorCodes.NOT_ATTACHED
ErrorCodes.TOKEN_REJECTED
ErrorCodes.COULD_BLOCK
ErrorCodes.UNAUTHORIZED
ErrorCodes.TOO_MANY_REQUESTS
ErrorCodes.UNKNOWN_PRODUCT_ID
ErrorCodes.UNKNOWN_DEVICE_ID
ErrorCodes.UNKNOWN_SERVER_KEY
ErrorCodes.CONNECTION_REFUSED
ErrorCodes.INTERNAL_ERROR
NabtoException interface
NabtoException
NabtoException.getErrorCode
NabtoCheckedException class
NabtoCheckedException
NabtoCheckedException.getErrorCode
NabtoRuntimeException class
NabtoRuntimeException
NabtoRuntimeException.getErrorCode
NabtoEOFException class
NabtoEOFException
NabtoNoChannelsException class
NabtoNoChannelsException
NabtoNoChannelsException.getLocalChannelErrorCode
NabtoNoChannelsException.getRemoteChannelErrorCode
NabtoNoChannelsException.getDirectCandidatesChannelErrorCode
NabtoCallback interface
NabtoCallback
NabtoCallback.run
Android Client IAM Util
Introduction
IamUtil class
IamUtil
IamUtil.create
IamUtil.pairLocalOpen
IamUtil.pairLocalOpenCallback
IamUtil.pairLocalInitial
IamUtil.pairLocalInitialCallback
IamUtil.pairPasswordOpen
IamUtil.pairPasswordOpenCallback
IamUtil.pairPasswordInvite
IamUtil.pairPasswordInviteCallback
IamUtil.getAvailablePairingModes
IamUtil.getDeviceDetails
IamUtil.getDeviceDetailsCallback
IamUtil.isCurrentUserPaired
IamUtil.isCurrentUserPairedCallback
IamUtil.getUser
IamUtil.getUserCallback
IamUtil.getCurrentUser
IamUtil.getCurrentUserCallback
IamUtil.getAvailableRoles
IamUtil.getAvailableRolesCallback
IamUtil.createUser
IamUtil.createUserCallback
IamUtil.updateUserPassword
IamUtil.updateUserPasswordCallback
IamUtil.updateUserRole
IamUtil.updateUserRoleCallback
IamUtil.updateUserDisplayName
IamUtil.updateUserDisplayNameCallback
IamUtil.renameUser
IamUtil.renameUserCallback
IamUtil.deleteUser
IamUtil.deleteUserCallback
Kotlin: IamUtil.awaitPairLocalOpen
Kotlin: IamUtil.awaitPairLocalInitial
Kotlin: IamUtil.awaitPairPasswordOpen
Kotlin: IamUtil.awaitPairPasswordInvite
Kotlin: IamUtil.awaitGetDeviceDetails
Kotlin: IamUtil.awaitGetAvailableRoles
Kotlin: IamUtil.awaitIsCurrentUserPaired
Kotlin: IamUtil.awaitGetUser
Kotlin: IamUtil.awaitGetCurrentUser
Kotlin: IamUtil.awaitCreateUser
Kotlin: IamUtil.awaitUpdateUserPassword
Kotlin: IamUtil.awaitUpdateUserRole
Kotlin: IamUtil.awaitUpdateUserDisplayName
Kotlin: IamUtil.awaitRenameUser
Kotlin: IamUtil.awaitDeleteUser
DeviceDetails class
DeviceDetails
DeviceDetails.getModes
DeviceDetails.getNabtoVersion
DeviceDetails.getAppVersion
DeviceDetails.getAppName
DeviceDetails.getProductId
DeviceDetails.getDeviceId
IamUser class
IamUser
IamUser.getUsername
IamUser.getDisplayName
IamUser.getFingerprint
IamUser.getSct
IamUser.getRole
IamError enum
IamError
IamError.NONE
IamError.BLOCKED_BY_DEVICE_CONFIGURATION
IamError.INITIAL_USER_ALREADY_PAIRED
IamError.USER_DOES_NOT_EXIST
IamError.ROLE_DOES_NOT_EXIST
IamError.USERNAME_EXISTS
IamError.INVALID_INPUT
IamError.PAIRING_MODE_DISABLED
IamError.IAM_NOT_SUPPORTED
IamError.AUTHENTICATION_ERROR
IamError.FAILED
PairingMode enum
PairingMode
PairingMode.LOCAL_OPEN
PairingMode.LOCAL_INITIAL
PairingMode.PASSWORD_OPEN
PairingMode.PASSWORD_INVITE
IamException class
IamException
IamException.getError
IamCallback interface
IamCallback
IamCallback.run
Android Client WebRTC
Introduction
WebRTC Connection
OnConnectedCallback
OnClosedCallback
OnTrackCallback
OnErrorCallback
EdgeWebrtcConnection
EdgeWebrtcConnection.onConnected
EdgeWebrtcConnection.onClosed
EdgeWebrtcConnection.onTrack
EdgeWebrtcConnection.onError
EdgeWebrtcConnection.connect
EdgeWebrtcConnection.connectionClose
MediaTrack
EdgeMediaTrackType
EdgeMediaTrack
EdgeVideoTrack
EdgeVideoTrack.add
EdgeVideoTrack.remove
EdgeAudioTrack
EdgeAudioTrack.setEnabled
EdgeAudioTrack.setVolume
WebRTC Manager
EdgeWebRTCLogLevel
EdgeWebRTCManager
EdgeWebRTCManager.setLogLevel
EdgeWebRTCManager.initVideoView
EdgeWebRTCManager.createRTCConnection
Errors
EdgeWebRTCError
EdgeWebRTCError.SignalingFailedToInitialize
EdgeWebRTCError.SignalingFailedRecv
EdgeWebRTCError.SignalingInvalidMessage
EdgeWebRTCError.SetRemoteDescriptionError
EdgeWebRTCError.SendAnswerError
EdgeWebRTCError.ICECandidateError
EdgeWebRTCError.ConnectionInitError
iOS
iOS Client SDK
Introduction
Client class
LogCallBackReceiver
AsyncStatusReceiver
NabtoEdgeClientLogMessage
Client
Client.init
Client.versionString
Client.createConnection
Client.createPrivateKey
Client.createMdnsScanner
Client.enableNsLogLogging
Client.setLogLevel
Client.setLogCallBack
Client.stop
Connection class
ConnectionEventReceiver
ConnectionEventReceiver.onEvent
Connection
Connection.connect
Connection.connectAsync
Connection.close
Connection.closeAsync
Connection.stop
Connection.updateOptions
Connection.setPrivateKey
Connection.setProductId
Connection.setDeviceId
Connection.setServerKey
Connection.setServerConnectToken
Connection.setServerJwtToken
Connection.passwordAuthenticate
Connection.passwordAuthenticateAsync
Connection.getOptions
Connection.getDeviceFingerprintHex
Connection.getClientFingerprintHex
Connection.getType
Connection.createStream
Connection.createCoapRequest
Connection.createTcpTunnel
Connection.addConnectionEventsReceiver
Connection.removeConnectionEventsReceiver
MdnsScanner class
MdnsResultReceiver
MdnsResultReceiver.onResultReady
MdnsScanner
MdnsScanner.start
MdnsScanner.stop
MdnsScanner.isStarted
MdnsScanner.addMdnsResultReceiver
MdnsScanner.removeMdnsResultReceiver
MdnsResult class
MdnsResult
MdnsResult.Action
MdnsResult.serviceInstanceName
MdnsResult.action
MdnsResult.deviceId
MdnsResult.productId
MdnsResult.txtItems
CoapRequest class
ContentFormat
ContentFormat.TEXT_PLAIN
ContentFormat.APPLICATION_XML
ContentFormat.APPLICATION_OCTET_STREAM
ContentFormat.APPLICATION_JSON
ContentFormat.APPLICATION_CBOR
CoapResponseReceiver
CoapRequest
CoapRequest.setRequestPayload
CoapRequest.setRequestPayloadString
CoapRequest.execute
CoapRequest.executeAsync
CoapRequest.stop
CoapResponse class
CoapResponse
CoapResponse.status
CoapResponse.contentFormat
CoapResponse.payload
Stream class
Stream
Stream.open
Stream.openAsync
Stream.write
Stream.writeAsync
Stream.readSome
Stream.readSomeAsync
Stream.readAll
Stream.readAllAsync
Stream.close
Stream.closeAsync
Stream.abort
Stream.stop
TcpTunnel class
TcpTunnel
TcpTunnel.open
TcpTunnel.openAsync
TcpTunnel.getLocalPort
TcpTunnel.close
TcpTunnel.closeAsync
TcpTunnel.stop
NabtoEdgeClientError enum
NabtoEdgeClientError
NabtoEdgeClientError.OK
NabtoEdgeClientError.ALLOCATION_ERROR
NabtoEdgeClientError.CONNECTION_REFUSED
NabtoEdgeClientError.DNS
NabtoEdgeClientError.EOF
NabtoEdgeClientError.FORBIDDEN
NabtoEdgeClientError.INVALID_ARGUMENT
NabtoEdgeClientError.INVALID_STATE
NabtoEdgeClientError.NONE
NabtoEdgeClientError.NOT_ATTACHED
NabtoEdgeClientError.NOT_CONNECTED
NabtoEdgeClientError.NOT_FOUND
NabtoEdgeClientError.NO_CHANNELS
NabtoEdgeClientError.NO_DATA
NabtoEdgeClientError.OPERATION_IN_PROGRESS
NabtoEdgeClientError.STOPPED
NabtoEdgeClientError.TIMEOUT
NabtoEdgeClientError.TOKEN_REJECTED
NabtoEdgeClientError.UNAUTHORIZED
NabtoEdgeClientError.UNKNOWN_DEVICE_ID
NabtoEdgeClientError.UNKNOWN_PRODUCT_ID
NabtoEdgeClientError.UNKNOWN_SERVER_KEY
NabtoEdgeClientError.API_UNKNOWN_ERROR
NabtoEdgeClientError.TOO_MANY_WRONG_PASSWORD_ATTEMPTS
NabtoEdgeClientError.PORT_IN_USE
NabtoEdgeClientError.FAILED
NabtoEdgeClientError.FAILED_WITH_DETAIL
NabtoEdgeClientError.UNEXPECTED_API_STATUS
iOS Client IAM Util
Introduction
IamUtil class
IamUtil
IamUtil.pairLocalOpen
IamUtil.pairLocalOpenAsync
IamUtil.pairLocalInitial
IamUtil.pairLocalInitialAsync
IamUtil.pairPasswordOpen
IamUtil.pairPasswordOpenAsync
IamUtil.pairPasswordInvite
IamUtil.pairPasswordInviteAsync
IamUtil.getAvailablePairingModes
IamUtil.getAvailablePairingModesAsync
IamUtil.getDeviceDetails
IamUtil.getDeviceDetailsAsync
IamUtil.isCurrentUserPaired
IamUtil.isCurrentUserPairedAsync
IamUtil.getUser
IamUtil.getUserAsync
IamUtil.getCurrentUser
IamUtil.getCurrentUserAsync
IamUtil.createUser
IamUtil.createUserAsync
IamUtil.updateUserPassword
IamUtil.updateUserPasswordAsync
IamUtil.updateUserRole
IamUtil.updateUserRoleAsync
IamUtil.updateUserDisplayName
IamUtil.updateUserDisplayNameAsync
IamUtil.renameUser
IamUtil.renameUserAsync
IamUtil.deleteUser
IamUtil.deleteUserAsync
IamUser
IamUser.Username
IamUser.DisplayName
IamUser.Fingerprint
IamUser.Sct
IamUser.Role
IamUser.decode
IamUser.encode
DeviceDetails
DeviceDetails.Modes
DeviceDetails.NabtoVersion
DeviceDetails.AppVersion
DeviceDetails.AppName
DeviceDetails.ProductId
DeviceDetails.DeviceId
DeviceDetails.FriendlyName
DeviceDetails.decode
IamError enum
IamError
IamError.OK
IamError.INVALID_INPUT
IamError.USERNAME_EXISTS
IamError.USER_DOES_NOT_EXIST
IamError.INITIAL_USER_ALREADY_PAIRED
IamError.ROLE_DOES_NOT_EXIST
IamError.AUTHENTICATION_ERROR
IamError.TOO_MANY_WRONG_PASSWORD_ATTEMPTS
IamError.PAIRING_MODE_DISABLED
IamError.BLOCKED_BY_DEVICE_CONFIGURATION
IamError.INVALID_RESPONSE
IamError.IAM_NOT_SUPPORTED
IamError.API_ERROR
IamError.FAILED
iOS Client WebRTC
Introduction
EdgePeerConnection
EdgeOnTrackCallback
EdgeOnOpenedCallback
EdgeOnClosedCallback
EdgeOnErrorCallback
EdgeOnMessageCallback
EdgeWebrtcError
EdgeWebrtcError.signalingFailedToInitialize
EdgeWebrtcError.signalingFailedRecv
EdgeWebrtcError.signalingFailedSend
EdgeWebrtcError.signalingInvalidMessage
EdgeWebrtcError.setRemoteDescriptionError
EdgeWebrtcError.sendAnswerError
EdgeWebrtcError.iceCandidateError
EdgeWebrtcError.connectionInitError
EdgeMediaTrack
EdgeVideoTrack
EdgeVideoTrack.add
EdgeVideoTrack.remove
EdgeAudioTrack
EdgeAudioTrack.setVolume
EdgeAudioTrack.setEnabled
EdgeDataChannel
EdgeDataChannel.onMessage
EdgeDataChannel.onOpened
EdgeDataChannel.onClosed
EdgeDataChannel.send
EdgeDataChannel.close
EdgePeerConnection
EdgePeerConnection.onTrack
EdgePeerConnection.onClosed
EdgePeerConnection.onError
EdgePeerConnection.createDataChannel
EdgePeerConnection.connect
EdgePeerConnection.close
EdgeWebRTC
EdgeWebrtcLogLevel
EdgeWebrtc
EdgeWebrtc.setLogLevel
EdgeWebrtc.createPeerConnection
JAVASCRIPT
JavaScript Client SDK
Introduction
WebRTC Connection
ClosedCallback
OnTrackCallback
ConnectionOptions
EdgeWebrtcConnection
EdgeWebrtcConnection.setConnectionOptions
EdgeWebrtcConnection.onClosed
EdgeWebrtcConnection.onTrack
EdgeWebrtcConnection.connect
EdgeWebrtcConnection.close
EdgeWebrtcConnection.coapInvoke
EdgeWebrtcConnection.passwordAuthenticate
EdgeWebrtcConnection.validateFingerprint
EdgeWebrtcConnection.createDatachannel
createEdgeWebrtcConnection
CoAP
CoapMethod
CoapContentFormat
CoapResponse
Errors
NabtoWebrtcErrorCode
NabtoWebrtcError
.NET
.NET Client SDK
INabtoClient
INabtoClient
INabtoClient.Create
INabtoClient.GetVersion
INabtoClient.CreatePrivateKey
INabtoClient.CreateConnection
INabtoClient.CreateMdnsScanner
INabtoClient.SetLogger
IConnection
IConnection
IConnection.ConnectionEvent
IConnection.ConnectionEventHandler
IConnection.ConnectionEventHandlers
IConnection.ConnectionType
IConnection.GetConnectionType
IConnection.SetOptions
IConnection.GetOptionsAsJson
IConnection.GetOptions
IConnection.GetDeviceFingerprint
IConnection.GetClientFingerprint
IConnection.ConnectAsync
IConnection.CloseAsync
IConnection.Stop
IConnection.PasswordAuthenticateAsync
IConnection.GetLocalChannelErrorCode
IConnection.GetRemoteChannelErrorCode
IConnection.CreateCoapRequest
IConnection.CreateStream
IConnection.CreateTcpTunnel
IMdnsScanner
IMdnsScanner
IMdnsScanner.ResultHandler
IMdnsScanner.Start
IMdnsScanner.Stop
IMdnsScanner.Handlers
ICoapRequest
ICoapRequest
ICoapRequest.SetRequestPayload
ICoapRequest.ExecuteAsync
ICoapRequest.Stop
ICoapResponse
ICoapResponse
ICoapResponse.GetResponseStatusCode
ICoapResponse.GetResponseContentFormat
ICoapResponse.GetResponsePayload
IStream
IStream
IStream.OpenAsync
IStream.ReadSomeAsync
IStream.ReadAllAsync
IStream.WriteAsync
IStream.CloseAsync
IStream.Stop
ITcpTunnel
ITcpTunnel
ITcpTunnel.OpenAsync
ITcpTunnel.CloseAsync
ITcpTunnel.GetLocalPort
ITcpTunnel.Stop
MdnsResult
MdnsResult
MdnsResult.MdnsAction
MdnsResult.ServiceInstanceName
MdnsResult.ProductId
MdnsResult.DeviceId
MdnsResult.Action
MdnsResult.TxtItems
ConnectionOptions
ConnectionOptions
ConnectionOptions.PrivateKey
ConnectionOptions.ProductId
ConnectionOptions.DeviceId
ConnectionOptions.ServerUrl
ConnectionOptions.ServerKey
ConnectionOptions.ServerJwtToken
ConnectionOptions.ServerConnectToken
ConnectionOptions.AppName
ConnectionOptions.AppVersion
ConnectionOptions.KeepAliveInterval
ConnectionOptions.KeepAliveRetryInterval
ConnectionOptions.KeepAliveMaxRetries
ConnectionOptions.DtlsHelloTimeout
ConnectionOptions.Local
ConnectionOptions.Remote
ConnectionOptions.Rendezvous
ConnectionOptions.ScanLocalConnect
CoapContentFormat
CoapContentFormat
CoapContentFormat.TEXT_PLAIN
CoapContentFormat.APPLICATION_XML
CoapContentFormat.APPLICATION_OCTET_STREAM
CoapContentFormat.APPLICATION_JSON
CoapContentFormat.APPLICATION_CBOR
NabtoClientError
NabtoClientError
NabtoClientError.OK
NabtoClientError.BAD_RESPONSE
NabtoClientError.BAD_REQUEST
NabtoClientError.CLOSED
NabtoClientError.DNS
NabtoClientError.EOF
NabtoClientError.FORBIDDEN
NabtoClientError.FUTURE_NOT_RESOLVED
NabtoClientError.INVALID_ARGUMENT
NabtoClientError.INVALID_STATE
NabtoClientError.NOT_CONNECTED
NabtoClientError.NOT_FOUND
NabtoClientError.NOT_IMPLEMENTED
NabtoClientError.NO_CHANNELS
NabtoClientError.NO_DATA
NabtoClientError.OPERATION_IN_PROGRESS
NabtoClientError.PARSE
NabtoClientError.PORT_IN_USE
NabtoClientError.STOPPED
NabtoClientError.TIMEOUT
NabtoClientError.UNKNOWN
NabtoClientError.NONE
NabtoClientError.NOT_ATTACHED
NabtoClientError.TOKEN_REJECTED
NabtoClientError.COULD_BLOCK
NabtoClientError.UNAUTHORIZED
NabtoClientError.TOO_MANY_REQUESTS
NabtoClientError.UNKNOWN_PRODUCT_ID
NabtoClientError.UNKNOWN_DEVICE_ID
NabtoClientError.UNKNOWN_SERVER_KEY
NabtoClientError.CONNECTION_REFUSED
NabtoClientError.PRIVILEGED_PORT
NabtoClientError.DEVICE_INTERNAL_ERROR
NabtoClientError.GetErrorMessage
NabtoClientError.GetErrorString
NabtoException
NabtoException
NabtoException.ErrorCode
.NET Client IAM Util
IamUtil
IamUtil
IamUtil.PairLocalInitialAsync
IamUtil.PairLocalOpenAsync
IamUtil.PairPasswordOpenAsync
IamUtil.PairPasswordInviteAsync
IamUtil.GetDeviceDetailsAsync
IamUtil.UpdateDeviceFriendlyNameAsync
IamUtil.GetIamSettingsAsync
IamUtil.UpdateIamSettingsPasswordOpenPairingAsync
IamUtil.UpdateIamSettingsPasswordInvitePairingAsync
IamUtil.UpdateIamSettingsLocalOpenPairingAsync
IamUtil.GetRolesAsync
IamUtil.GetNotificationCategoriesAsync
IamUtil.GetCurrentUserAsync
IamUtil.GetUserAsync
IamUtil.CreateUserAsync
IamUtil.UpdateUserFingerprintAsync
IamUtil.UpdateUserPasswordAsync
IamUtil.UpdateUserRoleAsync
IamUtil.UpdateUserSctAsync
IamUtil.UpdateUserUsernameAsync
IamUtil.UpdateUserDisplayNameAsync
IamUtil.DeleteUserAsync
IamUtil.UpdateUserFcmAsync
IamUtil.UpdateUserNotificationCategoriesAsync
DeviceDetails
DeviceDetails
DeviceDetails.Modes
DeviceDetails.NabtoVersion
DeviceDetails.AppVersion
DeviceDetails.AppName
DeviceDetails.ProductId
DeviceDetails.DeviceId
DeviceDetails.FriendlyName
IamUser
IamUser
IamUser.Username
IamUser.DisplayName
IamUser.Fingerprint
IamUser.Password
IamUser.Sct
IamUser.Role
IamUser.Fcm
IamUser.NotificationCategories
IamException
IamException
IamException.Error
IamSettings
IamSettings
IamSettings.PasswordOpenPairing
IamSettings.PasswordInvitePairing
IamSettings.LocalOpenPairing
IamSettings.PasswordOpenSct
IamSettings.PasswordOpenPassword
PLAIN C
Plain C Client SDK
Introduction
Client Context
Introduction
NabtoClient
nabto_client_new
nabto_client_free
nabto_client_free2
nabto_client_stop
nabto_client_stop2
Connection
Introduction
NabtoClientConnectionType
NabtoClientConnection
nabto_client_connection_new
nabto_client_connection_free
nabto_client_connection_stop
nabto_client_connection_set_options
nabto_client_connection_get_options
nabto_client_connection_set_product_id
nabto_client_connection_set_device_id
nabto_client_connection_set_server_api_key
nabto_client_connection_set_server_key
nabto_client_connection_set_server_jwt_token
nabto_client_connection_set_server_connect_token
nabto_client_connection_set_application_name
nabto_client_connection_set_application_version
nabto_client_connection_set_server_url
nabto_client_connection_set_private_key
nabto_client_connection_get_device_fingerprint
nabto_client_connection_get_device_fingerprint_hex
nabto_client_connection_get_device_fingerprint_full_hex
nabto_client_connection_get_client_fingerprint
nabto_client_connection_get_client_fingerprint_hex
nabto_client_connection_get_client_fingerprint_full_hex
nabto_client_connection_get_type
nabto_client_connection_enable_direct_candidates
nabto_client_connection_add_direct_candidate
nabto_client_connection_end_of_direct_candidates
nabto_client_connection_connect
nabto_client_connection_close
nabto_client_connection_get_local_channel_error_code
nabto_client_connection_get_remote_channel_error_code
nabto_client_connection_get_direct_candidates_channel_error_code
nabto_client_connection_get_info
nabto_client_connection_password_authenticate
NabtoClientConnectionEvent
nabto_client_connection_events_init_listener
Streams
Introduction
NabtoClientStream
nabto_client_stream_new
nabto_client_stream_free
nabto_client_stream_abort
nabto_client_stream_stop
nabto_client_stream_open
nabto_client_stream_read_all
nabto_client_stream_read_some
nabto_client_stream_write
nabto_client_stream_close
TCP Tunnelling
Introduction
NabtoClientTcpTunnel
nabto_client_tcp_tunnel_new
nabto_client_tcp_tunnel_free
nabto_client_tcp_tunnel_stop
nabto_client_tcp_tunnel_open
nabto_client_tcp_tunnel_close
nabto_client_tcp_tunnel_get_local_port
CoAP
Introduction
NabtoClientCoapContentFormat
NabtoClientCoap
nabto_client_coap_new
nabto_client_coap_free
nabto_client_coap_stop
nabto_client_coap_set_request_payload
nabto_client_coap_execute
nabto_client_coap_get_response_status_code
nabto_client_coap_get_response_content_format
nabto_client_coap_get_response_payload
mDNS
Introduction
nabto_client_mdns_resolver_init_listener
nabto_client_mdns_result_free
nabto_client_mdns_result_get_device_id
nabto_client_mdns_result_get_product_id
nabto_client_mdns_result_get_service_instance_name
nabto_client_mdns_result_get_txt_items
nabto_client_mdns_result_get_action
Futures
Introduction
NabtoClientFuture
NabtoClientFutureCallback
nabto_client_future_new
nabto_client_future_free
nabto_client_future_ready
nabto_client_future_set_callback
nabto_client_future_set_callback2
nabto_client_future_wait
nabto_client_future_timed_wait
nabto_client_future_error_code
Listeners
Introduction
NabtoClientListener
nabto_client_listener_connection_event
nabto_client_listener_new_mdns_result
nabto_client_listener_new
nabto_client_listener_free
nabto_client_listener_stop
Misc
Introduction
NabtoClientError
NabtoClientLogCallback
nabto_client_create_private_key
nabto_client_string_free
nabto_client_error_get_message
nabto_client_error_get_string
nabto_client_version
nabto_client_set_log_callback
nabto_client_set_log_level
EMBEDDED SYSTEMS
Embedded Device SDK
Introduction
Device Context
Introduction
NabtoDevice
NabtoDeviceError
nabto_device_new
nabto_device_start
nabto_device_close
nabto_device_stop
nabto_device_free
nabto_device_set_product_id
nabto_device_get_product_id
nabto_device_set_device_id
nabto_device_get_device_id
nabto_device_set_server_url
nabto_device_set_server_port
nabto_device_set_private_key
nabto_device_set_root_certs
nabto_device_set_app_name
nabto_device_get_app_name
nabto_device_set_app_version
nabto_device_get_app_version
nabto_device_set_local_port
nabto_device_set_p2p_port
nabto_device_get_local_port
nabto_device_get_p2p_port
nabto_device_create_private_key
nabto_device_get_device_fingerprint
nabto_device_get_device_fingerprint_hex
nabto_device_get_device_fingerprint_full_hex
nabto_device_set_basestation_attach
NabtoDeviceEvent
nabto_device_device_events_init_listener
nabto_device_listener_device_event
nabto_device_log_severity_as_string
NabtoDeviceIceServersRequest
Connection
Introduction
NabtoDeviceConnection
NabtoDeviceConnectionRef
nabto_device_connection_get_client_fingerprint
nabto_device_connection_get_client_fingerprint_hex
nabto_device_connection_get_client_fingerprint_full_hex
nabto_device_connection_is_local
nabto_device_connection_is_password_authenticated
nabto_device_connection_get_password_authentication_username
NabtoDeviceConnectionEvent
nabto_device_connection_events_init_listener
nabto_device_listener_connection_event
nabto_device_connection_get_connection_ref
nabto_device_connection_is_virtual
nabto_device_connection_get_device_fingerprint
Streams
Introduction
NabtoDeviceStream
nabto_device_stream_init_listener
nabto_device_stream_init_listener_ephemeral
nabto_device_listener_new_stream
nabto_device_stream_free
nabto_device_stream_accept
nabto_device_stream_get_connection_ref
nabto_device_stream_read_all
nabto_device_stream_read_some
nabto_device_stream_write
nabto_device_stream_close
nabto_device_stream_abort
TCP Tunnelling
Introduction
nabto_device_add_tcp_tunnel_service
nabto_device_remove_tcp_tunnel_service
nabto_device_add_tcp_tunnel_service_metadata
nabto_device_remove_tcp_tunnel_service_metadata
CoAP
Introduction
NabtoDeviceCoapMethod
nabto_device_coap_content_format
NabtoDeviceCoapRequest
NabtoDeviceCoapResourceHandler
nabto_device_coap_init_listener
nabto_device_listener_new_coap_request
nabto_device_coap_request_free
nabto_device_coap_error_response
nabto_device_coap_response_set_code
nabto_device_coap_response_set_payload
nabto_device_coap_response_set_content_format
nabto_device_coap_response_ready
nabto_device_coap_request_get_content_format
nabto_device_coap_request_get_payload
nabto_device_coap_request_get_connection_ref
nabto_device_coap_request_get_parameter
Service Invocation
Introduction
NabtoDeviceServiceInvocation
NabtoDeviceServiceInvokeMessageFormat
nabto_device_service_invocation_new
nabto_device_service_invocation_free
nabto_device_service_invocation_stop
nabto_device_service_invocation_set_service_id
nabto_device_service_invocation_set_message
nabto_device_service_invocation_execute
nabto_device_service_invocation_get_response_status_code
nabto_device_service_invocation_get_response_message_data
nabto_device_service_invocation_get_response_message_size
nabto_device_service_invocation_get_response_message_format
FCM Notifications
Introduction
NabtoDeviceFcmNotification
nabto_device_fcm_notification_new
nabto_device_fcm_notification_free
nabto_device_fcm_notification_set_project_id
nabto_device_fcm_notification_set_payload
nabto_device_fcm_send
nabto_device_fcm_stop
nabto_device_fcm_notification_get_response_status_code
nabto_device_fcm_notification_get_response_body
mDNS
Introduction
nabto_device_enable_mdns
nabto_device_mdns_add_subtype
nabto_device_mdns_add_txt_item
Futures
Introduction
NabtoDeviceFuture
NabtoDeviceFutureCallback
nabto_device_future_new
nabto_device_future_free
nabto_device_future_ready
nabto_device_future_set_callback
nabto_device_future_wait
nabto_device_future_timed_wait
nabto_device_future_error_code
Listeners
Introduction
NabtoDeviceListener
nabto_device_listener_new
nabto_device_listener_free
nabto_device_listener_stop
Password Authentication
Introduction
nabto_device_password_authentication_request_init_listener
nabto_device_listener_new_password_authentication_request
nabto_device_password_authentication_request_get_username
nabto_device_password_authentication_request_set_password
nabto_device_password_authentication_request_free
Authorization
Introduction
NabtoDeviceAuthorizationRequest
nabto_device_authorization_request_init_listener
nabto_device_listener_new_authorization_request
nabto_device_authorization_request_free
nabto_device_authorization_request_verdict
nabto_device_authorization_request_get_action
nabto_device_authorization_request_get_connection_ref
nabto_device_authorization_request_get_attributes_size
nabto_device_authorization_request_get_attribute_name
nabto_device_authorization_request_get_attribute_value
Server Connect Tokens
Introduction
nabto_device_create_server_connect_token
nabto_device_add_server_connect_token
nabto_device_are_server_connect_tokens_synchronized
Virtual Connections
Introduction
nabto_device_virtual_connection_new
nabto_device_virtual_connection_free
nabto_device_virtual_connection_close
nabto_device_virtual_connection_set_device_fingerprint
nabto_device_virtual_connection_set_client_fingerprint
nabto_device_virtual_coap_request_new
nabto_device_virtual_coap_request_free
nabto_device_virtual_coap_request_set_payload
nabto_device_virtual_coap_request_set_content_format
nabto_device_virtual_coap_request_execute
nabto_device_virtual_coap_request_get_response_status_code
nabto_device_virtual_coap_request_get_response_content_format
nabto_device_virtual_coap_request_get_response_payload
nabto_device_virtual_stream_new
nabto_device_virtual_stream_free
nabto_device_virtual_stream_open
nabto_device_virtual_stream_read_all
nabto_device_virtual_stream_read_some
nabto_device_virtual_stream_write
nabto_device_virtual_stream_close
nabto_device_virtual_stream_abort
ICE Servers Requests
Introduction
nabto_device_ice_servers_request_new
nabto_device_ice_servers_request_free
nabto_device_ice_servers_request_send
nabto_device_ice_servers_request_get_server_count
nabto_device_ice_servers_request_get_username
nabto_device_ice_servers_request_get_credential
nabto_device_ice_servers_request_get_urls_count
nabto_device_ice_servers_request_get_url
Limits
Introduction
nabto_device_limit_streams
nabto_device_limit_stream_segments
nabto_device_limit_connections
nabto_device_limit_coap_server_requests
nabto_device_limit_tcp_tunnel_connections
Logging
Introduction
NabtoDeviceLogLevel
NabtoDeviceLogMessage
NabtoDeviceLogCallback
nabto_device_set_log_callback
nabto_device_set_log_level
nabto_device_set_log_std_out_callback
Misc
Introduction
nabto_device_duration_t
nabto_device_version
nabto_device_error_get_message
nabto_device_error_get_string
nabto_device_string_free
IAM Device Module
Introduction
Life Cycle and Types
Introduction
nm_iam_state_changed
nm_iam_error
nm_iam_init
nm_iam_stop
nm_iam_deinit
nm_iam_load_configuration
nm_iam_load_state
nm_iam_set_state_changed_callback
nm_iam_dump_state
nm_iam_effect
nm_iam_condition_operator
Runtime State
Introduction
nm_iam_set_notification_categories
nm_iam_check_access
nm_iam_set_local_open_pairing
nm_iam_set_password_open_pairing
nm_iam_set_password_invite_pairing
nm_iam_set_local_initial_pairing
nm_iam_create_user
nm_iam_set_user_fingerprint
nm_iam_add_user_fingerprint
nm_iam_remove_user_fingerprint
nm_iam_set_user_sct
nm_iam_set_user_password
nm_iam_set_user_role
nm_iam_set_user_display_name
nm_iam_delete_user
nm_iam_authorize_connection
Configuration Builder
Introduction
nm_iam_configuration_new
nm_iam_configuration_free
nm_iam_configuration_set_unpaired_role
nm_iam_configuration_add_policy
nm_iam_configuration_add_role
nm_iam_configuration_policy_new
nm_iam_configuration_policy_free
nm_iam_configuration_policy_create_statement
nm_iam_configuration_statement_add_action
nm_iam_configuration_statement_create_condition
nm_iam_configuration_condition_add_value
nm_iam_configuration_role_new
nm_iam_configuration_role_free
nm_iam_configuration_role_add_policy
State Builder
Introduction
nm_iam_state_new
nm_iam_state_free
nm_iam_state_set_password_open_password
nm_iam_state_set_password_open_sct
nm_iam_state_set_password_open_pairing
nm_iam_state_set_local_open_pairing
nm_iam_state_set_password_invite_pairing
nm_iam_state_set_local_initial_pairing
nm_iam_state_set_open_pairing_role
nm_iam_state_set_initial_pairing_username
nm_iam_state_set_friendly_name
nm_iam_state_add_user
nm_iam_state_user_new
nm_iam_state_user_free
nm_iam_state_user_set_fingerprint
nm_iam_state_user_add_fingerprint
nm_iam_state_user_set_sct
nm_iam_state_user_set_display_name
nm_iam_state_user_set_role
nm_iam_state_user_set_password
nm_iam_state_user_set_notification_categories
nm_iam_state_user_set_oauth_subject
nm_iam_state_find_user_by_username
nm_iam_state_find_user_by_oauth_subject
nm_iam_state_copy
Serializer
Introduction
nm_iam_serializer_configuration_dump_json
nm_iam_serializer_configuration_load_json
nm_iam_serializer_state_dump_json
nm_iam_serializer_state_load_json
nm_iam_serializer_string_free
WebRTC Device SDK
Introduction
Nabto Device WebRTC
CheckAccessCallback
NabtoDevicePtr
NabtoDeviceWebrtc
NabtoDeviceWebrtc.create
NabtoDeviceWebrtc.connectionAddMediaTracks
NabtoDeviceWebrtc.setTrackEventCallback
NabtoDeviceWebrtc.setDatachannelEventCallback
NabtoDeviceWebrtc.setCheckAccessCallback
NabtoDeviceWebrtc.version
Media Track
TrackEventCallback
MediaRecvCallback
MediaTrack
MediaTrack.ErrorState
MediaTrack.create
MediaTrack.getTrackId
MediaTrack.getSdp
MediaTrack.setSdp
MediaTrack.send
MediaTrack.setReceiveCallback
MediaTrack.setCloseCallback
MediaTrack.setErrorState
Data Channel
DatachannelEventCallback
Datachannel
Datachannel.MessageType
Datachannel.DatachannelMessageCallback
Datachannel.getLabel
Datachannel.setMessageCallback
Datachannel.sendMessage
Datachannel.setCloseCallback
Event Queue
EventQueue
EventQueue.post
EventQueue.addWork
EventQueue.removeWork
EventQueueWork
EventQueueWork.EventQueueWork
EventQueueWork.~EventQueueWork
REMOTE APIS
CoAP Endpoints on Device
Introduction
IAM
Introduction
CoAP GET /iam/pairing
CoAP PUT /iam/device-info/friendly-name
CoAP POST /iam/pairing/local-open
CoAP POST /iam/pairing/password-open
CoAP POST /iam/pairing/local-initial
CoAP POST /iam/pairing/password-invite
CoAP GET /iam/settings
CoAP PUT /iam/settings/:setting
CoAP GET /iam/roles
CoAP GET /iam/me
CoAP GET /iam/users
CoAP POST /iam/users
CoAP GET /iam/users/:username
CoAP DELETE /iam/users/:username
CoAP PUT /iam/users/:username/:setting
CoAP PUT /iam/users/:username/fingerprints/:fingerprint
CoAP DELETE /iam/users/:username/fingerprints/:fingerprint
CoAP GET /iam/notification-categories
CoAP POST /iam/users/:username/fcm-test
Tunnels
Introduction
CoAP GET /tcp-tunnels/services
CoAP GET /tcp-tunnels/services/:serviceId
CoAP GET /tcp-tunnels/connect/:serviceId
Nabto Cloud API
Introduction
Nabto Edge Products
List Products
Get Product
Create Product
Modify Product
Delete Product
Get Product quota
Add Auth config to Product
Remove Auth config from Product
Add Service to Product
Remove Service from Product
Nabto Edge Devices
List Devices
Create Device
Get device batch
Create Device batch
Bulk set device fingerprints
Get Device
Modify device
Delete device
Nabto Edge Services
List Services
Create Service
Get Service
Modify Service
Nabto Edge Auth Configs
List Auth Configs
Create Auth Config
Get Auth Config
Modify Auth Config
Miscellaneous
Error Responses
Pagination
PairingMode.PASSWORD_INVITE()
DESCRIPTION
The
password invite
pairing mode
DECLARATION
PASSWORD_INVITE
