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
MS Word™ Document
MS Word™ Documents are a great way to distribute content. The document can be included in the Xcode or Eclipse project or it can be downloaded from a URL. Adjust the document behavior properties to best suit your needs.
Sample JSON
{"itemId":"99999", "itemType":"BT_screen_webView", "itemNickname":"Word Doc", "navBarTitleText":"Cool Letter", "localFileName":"sample.doc"}
* Required     * Overrides Global Theme
MS Word™ Document 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_webView"
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.
Document Location * "localFileName":"sample.doc"
OR
"dataURL":"http://mywebsite.com/sample.doc"
Use a localFileName or a dataURL, not both. If a localFileName is used, the file must exist in the BT_Docs folder in the Xcode or Eclipse project.
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.
Document Behavior
Show Browser Back Button "showBrowserBarBack":"0"
Options: 0 or 1 where 1 = yes. If a user clicks a link in a document that leads to another document a back button may be necessary to allow for navigation.
Show Browser Refresh Button "showBrowserBarRefresh":"0"
Options: 0 or 1 where 1 = yes. If the document comes from a URL a refresh button may be appropriate.
Show Launch in Native App Button "showBrowserBarLaunchInNativeApp":"0"
Options: 0 or 1 where 1 = yes. It's sometimes appropriate to allow the user to open the document in the native browser.
Show Email Document Button "showBrowserBarEmailDocument":"0"
Options: 0 or 1 where 1 = yes. This only works for some document types such as .PDF, .DOC, .PPT, and .XLS.
Force Refresh "forceRefresh":"0"
Options: 0 or 1 where 1 = yes. If the document comes from a URL the mobile app will attempt to save it for offline use (cached documents). Use this option to force refresh the document everytime the screen loads.
Detect Phone Numbers / Addresses "dataDetectorType":"1"
Options: 0 or 1 where 1 = yes. Some devices automatically highlight addresses and phone numbers and other special text in documents. This may or may not be appropriate.
Prevent All Scrolling "preventAllScrolling":"1"
Options: 0 or 1 where 1 = yes. Depending on the design, preventing scrolling may be appropriate.
Hide Vertical Scroll Bar "hideVerticalScrollBar":"1"
Options: 0 or 1 where 1 = yes. Only applies if preventAllScrolling is not set to 1.
Hide Horizontal Scroll Bar "hideHorizontalScrollBar":"1"
Options: 0 or 1 where 1 = yes. Only applies if preventAllScrolling is not set to 1.
Prevent Scroll Bounce "preventScrollBounce":"1"
Options: 0 or 1 where 1 = yes. Only applies if preventAllScrolling is not set to 1. Some devices add a bounce affect when scrolling, this may or may not be appropriate.
Prevent User Interaction "preventUserInteraction":"1"
Options: 0 or 1 where 1 = yes. Prevents all user interactions. Links and other elements on the document will not be selectable.
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.