v1.5 Documentation

These reference documents are designed to help you when things don't go as planned. The individual screen type documents are useful for looking up availalbe JSON properties.

Content Screens
Settings Screens
Splash Screens
Other Actions
Button Items
Button items are used in Button Menus. Every button on the menu is an individual button item. When a button on the menu selected, a new screen or menu loads. Button styles and sizes are adjusted in the Global Theme or in the parent Button Menu.
Sample JSON
{"itemId":"99999", "itemType":"BT_buttonItem", "loadScreenWithItemId":"unique id of screen to load"}
* Required
Button Item Properties
Item Id * "itemId":"a unique id"
A unique number or string identifiying this item from all other items in the configuration file.
Item Type * "itemType":"BT_buttonItem"
Used by the mobile app to determine what type of item to create.
Load Screen * "loadScreenWithItemId":"Another screen itemId"
"loadScreenWithNickname":"Another screen nickname"
"loadScreenObject":{a JSON sreen object}
The itemId, or the nickname, or the the JSON data for a screen or menu or feature. Only one of these three properties will be used.
Label Text "titleText":"My Button"
The position of the buttons text is setup in the Global Theme or in the parent List Menu.
Background Image Small Device "imageNameSmallDevice":"smallButton.png"
Use imageNameSmallDevice or imageURLSmallDevice, not both.
Background Image Large Device "imageNameLargeDevice":"largeButton.png"
Use imageNameLargeDevice or imageURLLargeDevice, not both.
Icon "iconName":"gears.png"
You can use icons with background image or without. Icon file must exist in Xcode or Android project.
Transition Type "transitionType":"flip"
Leave this blank for devices default transition. Or, use one of these values: fade, flip, curl, grow, slideUp, slideDown.
Sound Effect "soundEffectFileName":"ping.mp3"
The sound effect file must exist in the Xcode or Eclipse project. The sound effect file must be less than 1 second in duration.