Skip to content

Application

javier7ar edited this page Jun 20, 2018 · 9 revisions

The application object

The application object has 3 required fields and 4 optional fields:

  • title: String. It's the application title or name.
  • welcomeMessage: String. It's the message showed in the MyMainSamplersActivity
  • networkConfiguration: Object. It's the configuration used to send the samples through internet. It has 2 required fields and 2 optional fields
    • url: String. The url of the server to send HTTP POST message with the sample.
    • paramName: String. The param name of the HTTP POST message used to send the sample.
    • paramNameUserId: [OPTIONAL] String. The param name of the HTTP POST message used to send the user id.
    • paramNameAuthenticationType: [OPTIONAL] String. The param name of the HTTP POST message used to send the authentication type.
  • googleMaps_API_KEY: [OPTIONAL] String. Your Google API key. Only needed if you will use Location and Maps services (Location Step or Route Step). If you dont have one, you can get a Google API key
  • mainHelpFileName: [OPTIONAL] String. The file name of the HTML file containing the main application help. This file must be located with the SamplersConfig.json file. See the Showing Help section form more details
  • authenticationEnabled: [OPTIONAL] Boolean. Sets where the authentication will be enabled (true) or disabled (false).
  • authenticationOptional: [OPTIONAL] Boolean. Sets where the authentication will be optional (true) or required (false)

Note: To use authentication with google (the standard authentication provided by Samplers) you will need to register your application in Google to allow it. See the authentication section for more details

Example:

{
  "application": {
    "title" : "Samplers Hello World App",
    "welcomeMessage" : "Welcome to your first Samplers App!",
    "networkConfiguration" : {
      "url" : "http://192.168.1.10/samplers/upload.php",
      "paramName" : "sample",
      "paramNameUserId" : "user_id",
      "paramNameAuthenticationType" : "authentication_type"
    },
    "authenticationEnabled" : true,
    "authenticationOptional" : true,
    "googleMaps_API_KEY" : "your_google_maps_API_KEY",
    "mainHelpFileName" : "mainhelp.html"
  } 
}

Clone this wiki locally