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.

Menus
Content Screens
Settings Screens
Splash Screens
Other Actions
Image Gallery
Image galleries display a list of images. The galleries behavior can be modified to include options for emailing images, saving images, etc. The list of images can be provided in the screens The images in the gallery can come from the screens configuration data or a remote file hosted on a backend server. Hosting the list of images on a remote server allows for dynamic changes. This sample text file shows the format of a remote list of images. See this document for other ways to provide images.
Sample JSON
{"itemId":"99999", "itemType":"BT_screen_images", "itemNickname":"Image Gallery", "navBarTitleText":"Cool Images", "navBarStyle":"transparent", "startImageIndex":"1", "showEmailImageButton":"1", "dataURL":"http://mywebsite.com/imagesForApp.php"}
* Required     * Overrides Global Theme
Image Gallery 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_screen_images"
Used by the mobile app to determine what type of item to create.
Item Nickname * "itemNickname":"A unique nickname"
The nickname of the item in the buzztouch control panel.
Child Items "childItems":[Array of Images]
An array of Child Item JSON objects representing each image. Do not use a childItems array if the screen pulls it's images from a dataURL.
Data URL "dataURL":"http://www.mysite.com/imagesForApp.php"
A URL pointing to a file containing an array of Child Item JSON objects representing each image. Do not use a dataURL if the screen uses a childItems array.
Status Bar, Navigation Bar
Status Bar Style * "statusBarStyle":"default"
Options: default, solid, transparent, hidden.
Navigation Bar Title "navBarTitleText":"The Screen Title"
The title text that shows in the navigation bar.
Navigation Bar Style * "navBarStyle":"solid"
Options: solid, transparent, hidden.
Navigation Bar Color * "navBarBackgroundColor":"#000000"
Hexidecimal color.
Left Button Text "navBarBackButtonText":"Back"
Keep this short.
Right Button Type "navBarRightButtonType":"infoLight"
Omit this property or leave the value blank for no right button.
Options: home, next, infoLight, infoDark, details, done, cancel, save, add, addBlue, compose, reply, action, organize, bookmark, search, refresh, camera, trash, play, pause, stop, rewind, fastForward
This property sets the image's type, it does not determine what happens when the button is tapped. The Right Button Load Screen is what determines what happens when the button is tapped.
Right Button Load Screen "navBarRightButtonTapLoadScreenItemId":"Another screen itemId"
OR
"navBarRightButtonTapLoadScreenNickname":"Another screen nickname"
OR
"navBarRightButtonTapLoadScreenObject":{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.
Keywords: Set the navBarRightButtonTapLoadScreenItemId to "back", "home" or "showAudioControls" for special behaviors. These option will not load a screen but will perform the action associated with the keyword.
Right Button Transition Type "navBarRightButtonTapTransitionType":"flip"
Leave this blank for devices default transition. Or, use one of these values: fade, flip, curl, grow, slideUp, slideDown.
Hide Bottom Tab Bar "hideBottomTabBarWhenScreenLoads":"0"
Options: 0 or 1 where 1 = yes. This property is ignored when this screen is set as the home screen for a tab or if the app does not use a tabbed layout.
Gallery Behavior
Start Image Index "startImageIndex":"1"
The number of the image to start with.
Randomize Image Order "randomizeImages":"1"
Options: 0 or 1 where 1 = yes.
Show Count as Title "showCountInNavBar":"1"
Options: 0 or 1 where 1 = yes. 0 (no) shows navBarTitleText as the title in the navigation bar.
Cache Web-Images "cacheWebImages":"1"
Options: 0 or 1 where 1 = yes. Cached images load faster but take up storage space on the device.
Show Previous / Next Buttons "showImageNavButtons":"1"
Options: 0 or 1 where 1 = yes.
Show Email Image Button "showEmailImageButton":"1"
Options: 0 or 1 where 1 = yes.
Show Save Image Button "showSaveImageButton":"1"
Options: 0 or 1 where 1 = yes.
Show Refresh Button "showRefreshButton":"1"
Options: 0 or 1 where 1 = yes. Only useful if images come from a remote server.
Image Title Position "imageTitlePosition":"top"
Options: top, bottom, none
Image Title Font Size "imageTitleFontSize":"18"
Numeric, 18 is default.
Background Color, Image
Background Color * "backgroundColor":"#000000"
Hexidecimal color or a keyword: "clear" or "stripes" (do not enter quotes).
Background Color Transparency * "backgroundColorOpacity":"100"
Numeric Value: 1 - 100, 1 is totally transparent.
Background Color Gradient Top * "backgroundColorGradientTop":"#000000"
Hexidecimal color. Background gradients flow top-to-bottom and are placed "on-top" of a possible background color.
Background Color Gradient Bottom * "backgroundColorGradientTop":"#FFFFFF"
Hexidecimal color. Background gradients flow top-to-bottom and are placed "on-top" of a possible background color.
Background Image Small Device * "backgroundImageNameSmallDevice":"background-small.png"
OR
"backgroundImageURLSmallDevice":"URL to background-small.png"
The file name of the image added to the project or the URL to the image. Background images are placed "on-top" of possible background colors. Use an image name OR a URL, not both.
Background Image Large Device * "backgroundImageNameLargeDevice":"background-large.png"
OR
"backgroundImageURLLargeDevice":"URL to background-large.png"
The file name of the image added to the project or the URL to the image. Background images are placed "on-top" of possible background colors. Use an image name OR a URL, not both.
Background Image Transparency * "backgroundImageOpacity":"100"
Number: 1 - 100, 1 is totally transparent.
Background Image Scale * "backgroundImageScale":"center"
Options: center, fullScreen, fullScreenPreserve, top, bottom, topLeft, topRight, bottomLeft, bottomRight.
Background Audio
Audio File Location * "audioFileName":"sampleAudio.mp3"
OR
"audioFileURL":"http://mysite.com/sampleAudio.mp3"
The filename of the file included in the project or the URL to the file. If a audioFileURL is used then audioFileName should not be included. The audioFileURL is an internet address pointing to an actual file, not an an address the loads an HTML or Flash webpage with an embedded media player.
Audio Stops on Screen Exit "audioStopsOnScreenExit":"1"
Options: 0 or 1 where 1 = yes.
Audio Number of Loops "audioNumberOfLoops":"1"
Set this to 1 to play the audio track once. Set this to -1 to play the track indefinitely.
Other
Login Required "loginRequired":"0"
Options: 0 or 1 where 1 = yes. App must implement a Login screen.
Hide From Search "hideFromSearch":"0"
Options: 0 or 1 where 1 = yes. Hides from search results if the app implements a Search Menu screen.