image description
  • SOLUTION
  • DEVELOPER
  • CASES
  • PARTNERS
  • PRICING
  • BLOG

Documentation

  • Overview
  • Edge Guides
  • Edge API Reference
  • API REFERENCE
    • Introduction
      • NabtoClient
      • NabtoClient.create
      • NabtoClient.setLogLevel
      • NabtoClient.createPrivateKey
      • NabtoClient.createConnection
      • NabtoClient.addMdnsResultListener
      • NabtoClient.removeMdnsResultListener
      • NabtoClient.version
      • 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.close
      • Connection.connect
      • Connection.passwordAuthenticate
      • Connection.addConnectionEventsListener
      • Connection.removeConnectionEventsListener
      • ConnectionEventsCallback
      • ConnectionEventsCallback.onEvent
      • MdnsResult
      • MdnsResult.Action
      • MdnsResult.getDeviceId
      • MdnsResult.getProductId
      • MdnsResult.getServiceInstanceName
      • MdnsResult.getTxtItems
      • MdnsResult.getAction
      • Coap
      • Coap.setRequestPayload
      • Coap.execute
      • Coap.getResponseStatusCode
      • Coap.getResponseContentFormat
      • Coap.getResponsePayload
      • ContentFormat
      • ContentFormat.TEXT_PLAIN
      • ContentFormat.APPLICATION_XML
      • ContentFormat.APPLICATION_OCTET_STREAM
      • ContentFormat.APPLICATION_CBOR
      • Stream
      • Stream.open
      • Stream.readSome
      • Stream.readAll
      • Stream.write
      • Stream.close
      • Stream.abort
      • TcpTunnel
      • TcpTunnel.open
      • TcpTunnel.close
      • TcpTunnel.getLocalPort
      • ErrorCode
      • 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
      • NabtoException
      • NabtoException.getErrorCode
      • NabtoCheckedException
      • NabtoCheckedException.getErrorCode
      • NabtoRuntimeException
      • NabtoRuntimeException.getErrorCode
      • NabtoEOFException
      • NabtoNoChannelsException
      • NabtoNoChannelsException.getLocalChannelErrorCode
      • NabtoNoChannelsException.getRemoteChannelErrorCode
      • NabtoNoChannelsException.getDirectCandidatesChannelErrorCode
    • Introduction
      • Client
      • Client.init
      • Client.versionString
      • Client.createConnection
      • Client.createPrivateKey
      • Client.createMdnsScanner
      • Client.enableNsLogLogging
      • Client.setLogLevel
      • Client.setLogCallBack
      • Client.stop
      • 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.createStream
      • Connection.createCoapRequest
      • Connection.createTcpTunnel
      • Connection.addConnectionEventsReceiver
      • Connection.removeConnectionEventsReceiver
      • ConnectionEventReceiver
      • ConnectionEventReceiver.onEvent
      • MdnsScanner
      • MdnsScanner.start
      • MdnsScanner.stop
      • MdnsScanner.isStarted
      • MdnsScanner.addMdnsResultReceiver
      • MdnsScanner.removeMdnsResultReceiver
      • MdnsResult
      • MdnsResult.serviceInstanceName
      • MdnsResult.action
      • MdnsResult.deviceId
      • MdnsResult.productId
      • MdnsResult.txtItems
      • Action
      • MdnsResultReceiver.onResultReady
      • MdnsResultReceiver
      • CoapRequest
      • CoapRequest.setRequestPayload
      • CoapRequest.setRequestPayloadString
      • CoapRequest.execute
      • CoapRequest.executeAsync
      • CoapRequest.stop
      • CoapResponse
      • CoapResponse.status
      • CoapResponse.contentFormat
      • CoapResponse.payload
      • 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
      • TcpTunnel.open
      • TcpTunnel.openAsync
      • TcpTunnel.getLocalPort
      • TcpTunnel.close
      • TcpTunnel.closeAsync
      • TcpTunnel.stop
      • 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
      • DeviceDetails
      • DeviceDetails.Modes
      • DeviceDetails.NabtoVersion
      • DeviceDetails.AppVersion
      • DeviceDetails.AppName
      • DeviceDetails.ProductId
      • DeviceDetails.DeviceId
      • DeviceDetails.decode
      • IamUser
      • IamUser.Username
      • IamUser.DisplayName
      • IamUser.Fingerprint
      • IamUser.Sct
      • IamUser.Role
      • IamUser.decode
      • IamUser.encode
      • 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.FAILED
      • NabtoEdgeClientError.FAILED_WITH_DETAIL
      • NabtoEdgeClientError.UNEXPECTED_API_STATUS
    • Introduction
      • Introduction
      • NabtoClient
      • nabto_client_new
      • nabto_client_free
      • nabto_client_free2
      • nabto_client_stop
      • nabto_client_stop2
      • Introduction
      • NabtoClientConnectionType
      • NabtoClientConnection
      • NabtoClientConnectionEvent
      • 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_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_client_fingerprint
      • 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
      • nabto_client_connection_events_init_listener
      • 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
      • 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
      • 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
      • 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
      • Introduction
      • NabtoClientFuture
      • NabtoClientFutureCallback
      • nabto_client_future_new
      • nabto_client_future_free
      • nabto_client_future_set_callback
      • nabto_client_future_set_callback2
      • nabto_client_future_wait
      • nabto_client_future_timed_wait
      • nabto_client_future_error_code
      • 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
      • 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
    • Introduction
      • Introduction
      • NabtoDevice
      • NabtoDeviceError
      • nabto_device_new
      • nabto_device_start
      • NabtoDeviceEvent
      • 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
      • nabto_device_device_events_init_listener
      • nabto_device_listener_device_event
      • nabto_device_log_severity_as_string
      • Introduction
      • NabtoDeviceConnection
      • NabtoDeviceConnectionRef
      • NabtoDeviceConnectionEvent
      • 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
      • nabto_device_connection_events_init_listener
      • nabto_device_listener_connection_event
      • 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
      • Introduction
      • nabto_device_add_tcp_tunnel_service
      • nabto_device_remove_tcp_tunnel_service
      • 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
      • Introduction
      • NabtoDeviceServiceInvocation
      • 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
      • 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
      • Introduction
      • nabto_device_enable_mdns
      • nabto_device_mdns_add_subtype
      • nabto_device_mdns_add_txt_item
      • 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
      • Introduction
      • NabtoDeviceListener
      • nabto_device_listener_new
      • nabto_device_listener_free
      • nabto_device_listener_stop
      • 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
      • 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
      • Introduction
      • nabto_device_create_server_connect_token
      • nabto_device_add_server_connect_token
      • nabto_device_are_server_connect_tokens_synchronized
      • 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
      • Introduction
      • NabtoDeviceLogLevel
      • NabtoDeviceLogMessage
      • NabtoDeviceLogCallback
      • nabto_device_set_log_callback
      • nabto_device_set_log_level
      • nabto_device_set_log_std_out_callback
      • Introduction
      • nabto_device_duration_t
      • nabto_device_version
      • nabto_device_error_get_message
      • nabto_device_error_get_string
      • nabto_device_string_free
    • Introduction
      • Introduction
      • CoAP GET /iam/pairing
      • 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 GET /iam/notification-categories
      • CoAP POST /iam/users/:username/fcm-test
      • Introduction
      • CoAP GET /tcp-tunnels/services
      • CoAP GET /tcp-tunnels/services/:serviceId
      • CoAP GET /tcp-tunnels/connect/:serviceId