Survey123 field app API reference
This API reference is to be used by developers who choose to create Survey123 add-ins to extend the capabilty of the Survey123 field app. Add-ins can replace or compliment existing Survey123 functionality.
This functionality is in beta. This means that documentation is incomplete, but is provided for early adopters to start working with, to help guide the development of the API and its documentation.
Root level component of the add-in | |
Will alter how the default camera behaves when used to capture images | |
Component that is used within an add-in | |
Will alter the look and behaviour of a question in a survey | |
Indicator displayed when a tool is set as a tab | |
Page that is used within an add-in | |
Will alter how the default camera behaves by returning text or numeric values | |
Custom settings page for the add-in | |
A tool can appear as a tab on start up, a tile in the gallery, or run as a service | |
**TBC** Access to the currently used database for local storage of records | |
**TBC** Access to the forms on the device | |
Access to the location provider currently configured in the field app | |
Handles authenticated network requests | |
Singleton object that exposes interfaces to the field app |