The setter methods are used to change the content, layout, or formatting of a Weever app. To call, you must set app=ajax and m= one of the options below.
Navigation Tab Configuration
Note:: All calls should also contain, at minimum, the variables cms, version, and generator. These are omitted in the examples to save space.
Add Tab
| ajax::add_tab
|
| Description
|
Adds a new item to a navigation tab.
|
| Example Usages
|
Add a blog, add a Twitter feed, add a contact form, etc
|
| Guide
|
This method is much more complex than others. Learn how to use it through our guide on adding navigation tab items.
|
| Since version
|
0.1
|
| Updated last
|
1.0
|
| Variables
|
|
Type
|
Description
|
name
|
string
|
Name of the subtab item
|
component
|
componentType
|
A specific component type
|
published
|
boolean
|
0 or 1 for published status
|
ordering
|
int
|
What order to assign it
|
cms_feed
|
url
|
A feed from CMS system, in R3S Format
|
component_behaviour
|
string
|
Varies in use
|
type
|
tabType
|
Nav tab type, IE blog, page, calendar, social
|
var
|
json
|
Variable data, use varies.
|
| Example call
|
app=ajax&m=add_tab&site_key=[[SITE KEY HERE]]&name=@WeeverApps&component=twitteruser&published=1&ordering=0.1&component_behaviour=@weeverapps&type=social
|
| Returns on success
|
Item Added
|
Delete Tab
| ajax::delete_tab
|
| Use
|
Removes an item from a navigation tab.
|
| Since version
|
0.1
|
| Variables
|
|
Type
|
Description
|
cloud_tab_id
|
int
|
Server ID of the tab to be deleted
|
| Example call
|
app=ajax&m=delete_tab&site_key=[[SITE KEY HERE]]&cloud_tab_id=12345
|
| Returns on success
|
Item Deleted
|
Edit a Tab Icon
| ajax::edit_tab_icon
|
| Use
|
Edits a navigation tab's icon.
|
| Since version
|
0.9
|
| Variables
|
|
Type
|
Description
|
icon
|
base64
|
A base64-encoded icon image, can use Src.Sencha.Io to convert PNG image to base64 for this
|
type
|
tabType
|
The tab type, blog, page, etc
|
| Example call
|
app=ajax&m=edit_tab_icon&site_key=[[SITE KEY HERE]]&type=blog&icon=[[base64 string here]]
|
| Returns on success
|
|
Edit a Tab Name
| ajax::edit_tab_name
|
| Use
|
Edits the name of a navigation tab.
|
| Since version
|
0.9
|
| Variables
|
Var
|
Type
|
Description
|
| name
|
string
|
New name of the tab
|
| id
|
int
|
The ID of the tab
|
| Example call
|
app=ajax&m=edit_tab_name&site_key=[[SITE KEY HERE]]&id=12345&name=NewName
|
| Returns on success
|
Tab Changes Saved
|
Publish or Unpublish a Tab
| ajax::publish_tab
|
| Use
|
Publishes or unpublishes a tab item.
|
| Since version
|
0.3
|
| Variables
|
Var
|
Type
|
Description
|
| published
|
boolean
|
1 or 0 for published or unpublished
|
| cloud_tab_id
|
int
|
Server tab ID
|
| Example call
|
app=ajax&m=publish_tab&site_key=[[SITE KEY HERE]]&cloud_tab_id=12345&published=1
|
| Returns on success
|
Item Published or Item Unpublished
|
Update Sort Order of Navigation Tabs
| ajax::update_order
|
| Use
|
Sorts the order of either navigation tabs, or tab items.
|
| Since version
|
0.9
|
| Variables
|
Var
|
Type
|
Description
|
| reordering
|
json
|
A JSON object containing an array of Server Tab IDs in desired order.
|
| Example call
|
app=ajax&m=update_order&site_key=[[SITE KEY HERE]]&reordering=[[JSON object here]]
|
| Returns on success
|
Order Updated
|
Update a Tab's Settings
| ajax::update_tab_settings
|
| Use
|
Changes configuration settings associated with a specific tab. (Currently only used with tab types: map, panel, aboutapp)
|
| Since version
|
1.2
|
| Variables
|
Var
|
Type
|
Description
|
| var
|
json
|
JSON object containing settings specific to the tab type
|
| id
|
int
|
Server tab ID
|
| type
|
tabType
|
Tab type
|
| Example call
|
app=ajax&m=update_tab_settings&site_key=[[SITE KEY HERE]]&id=12345&var=[[JSON object]]
|
| Returns on success
|
Tab Settings Saved
|
Delete All Tab Items
| ajax::app_reset
|
| Use
|
Removes all items from all navigation tabs.
|
| Since version
|
1.7.2
|
| Variables
|
None. You better be sure about it when you make this call!
|
| Example call
|
app=ajax&m=app_reset&site_key=[[SITE KEY HERE]]
|
| Returns on success
|
App Tabs Cleared
|
App Configuration & Design
Set App Status as Offline or Online
| ajax::app_status
|
| Use
|
Changes an app's status from offline to online, used for Joomla/WordPress to check and see whether the site should forward a smartphone/tablet user to the app or not. Non-Joomla/WordPress setups are free to make use of this to store your app's status on our server.
|
| Since version
|
0.9.2
|
| Variables
|
|
Type
|
Description
|
app_enabled
|
boolean
|
0 or 1 if offline or online
|
| Example call
|
app=ajax&m=app_status&site_key=[[SITE KEY HERE]]&app_enabled=1
|
| Returns on success
|
App Online or App Offline
|
Change App CSS Styles
| ajax::edit_css
|
| Use
|
Adds custom CSS styles to the mobile app.
|
| Since version
|
1.4.5
|
| Variables
|
Var
|
Type
|
Description
|
| css
|
css
|
A string containing custom CSS styles.
|
| url
|
url
|
An URL to a CSS file to be called by the mobile app.
|
| Example call
|
app=ajax&m=edit_css&site_key=[[SITE KEY HERE]]&url=http://myname.com/appstyles.css
|
| Returns on success
|
CSS Updated
|
Change Titlebar Custom HTML
| ajax::edit_titlebar_html
|
| Use
|
Adds custom HTML to use for the header area (titlebar) of the mobile app.
|
| Since version
|
1.4.5
|
| Variables
|
Var
|
Type
|
Description
|
| html
|
html
|
A string containing custom HTML.
|
| Example call
|
app=ajax&m=edit_css&site_key=[[SITE KEY HERE]]&url=http://myname.com/appstyles.css
|
| Returns on success
|
CSS Updated
|
Change App Configuration
| ajax::edit_config
|
| Use
|
Edits the configuration settings of an app. These settings are typically any setting that is not relating to any of the navigation tabs, or the visual layout.
|
| Since version
|
0.6
|
| Variables
|
|
Type
|
Description
|
devices
|
string
|
A comma-separated list of device-detection functions for MobileESP, used with our Joomla/WordPress for forwarding purposes.
|
domain
|
url
|
A custom URL for the app, which is registered with us through this var. IE "app.yourname.com" (Pro White-Label subscribers only)
|
google_analytics
|
string
|
A Google UA-code for tracking app anayltics
|
loadspinner
|
html
|
A custom "Powered by..." message during app-loading (HTML allowed; Pro White-Label subscribers only)
|
local
|
string
|
Localization setting for the app.
|
| Example call
|
app=ajax&m=edit_config&site_key=[[SITE KEY HERE]]&devices=WeeverTierSmartphones,WeeverTierTabets&domain=app.yourname.com&google_analytics=UA-XXXXX-01&loadspinner=[[Loadspinner message]]
|
| Returns on success
|
|
Change Theme Settings
| ajax::edit_theme
|
| Use
|
Edits the theme settings of an app.
|
| Since version
|
0.8
|
| Last updated
|
1.4.5
|
| Variables
|
|
Type
|
Description
|
theme
|
object
|
An object with the properties below:
template: (string) The ID code of the template for this app.
titlebarSource: (string) Either image, html, or text.
titlebarHtml: (html) Custom HTML to use in the title bar area, if titlebarSource=="html".
css: (css) Custom CSS to add to the app.
css_url: (url) An URL to a custom CSS stylesheet.
|
titlebar_title
|
string
|
The text to use if theme::titlebarSource == "text".
|
launch
|
object
|
An object that sets launchscreen animation settings with the properties below:
animation: The animation type.
duration: How long the animation should take (in ms).
timeout: How long until the transition animation is to execute (in ms).
install_prompt: 0 or 1, if visitor is to be prompted to add the app to their Home Screen.
|
| Returns on success
|
|
Edit Image
| ajax::edit_image
|
| Use
|
Changes any image associated with the app design.
|
| Since version
|
1.3
|
| Variables
|
Var
|
Type
|
Description
|
| url
|
url
|
An URL to the image being added
|
| type
|
imageType
|
The type of image being changed
|
| Example call
|
app=ajax&m=edit_image&site_key=[[SITE KEY HERE]]&url=http://mysite.com/images/myimage.png&type=phone_load
|
| Returns on success
|
Image updated
|
Stage App Management
Delete a Staging Mode App
| ajax::delete_stage_app
|
| Use
|
Deletes the app entirely from the staging server.
|
| Since version
|
1.7.2
|
| Variables
|
None. You better be sure about it when you make this call!
|
| Example call
|
app=ajax&m=delete_stage_app&site_key=[[SITE KEY HERE]]
|
| Returns on success
|
Stage App Deleted
|
App Creation
This API information is forthcoming. It will only be usable by those within our third-party developer partnership program.
