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
Share via Facebook™
Launches a Facebook™ login screen if the user is not already logged into the default Facebook™ app on their device. If the user is logged in, the Facebook™ compose sheet is pre-configured with a message to post. Visit your Facebook™ account for information about how to get an API key and secret.
Sample JSON
{"itemId":"99999", "itemType":"BT_screen_shareFacebook", "itemNickname":"Facebook", "navBarTitleText":"Post on Wall", "facebookMessage":"You should see this app!", "facebookAPIKey":"facebook api key", "facebookAPISecret", "facebook api secret"}
* Required     * Overrides Global Theme
Share via Facebook™ 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_shareTwitter"
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.
Message * "tweetMessage":"A message..."
A message to pre-configure the compose screen with, 140 chars max. The pre-filled message cannot contain any carriage returns or line-breaks.
Facebook™ API Key * "facebookAPIKey":"key...."
API's Key associated with an app created on the Facebook system.
Facebook™ Secret * "facebookAPIKey":"secret..."
API key associated with an app created on the Facebook system.
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.
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.
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.