Mobile Configuration Documentation

Add Animation

This action is for adding view with animation.

Add Contact

This action is for adding contact to address book with details provided in parameters. On successfully adding contact “Phone Contact Added” event will be triggered, so any actions you want perform after adding contact can be configured in “Phone Contact Added” event listed in ”ACTION(S)” tab of the control on which you are configuring “Add Contact” action. Details of added contact can be retrieved as response parameters of Phone Contact Added” event. Following are the response parameters:- PersonIndex First Last full_name address_first Address email_first Email phone_first Phone Date Instant Message Profile Related People URL ThumbNailImage thumbImagePath OriginalImage

Add google analytics event

This action is for recording an event of your app in google analytics. Events are a useful way to collect data about a user's interaction with interactive components of your app, like button presses. This action works only if you set "Tracking Id", "Tracking Name" and enable "Enable Google Analytics" in "GOOGLE_ANALYTICS" settings under "THIRD PARTY APPLICATIONS". Following are the steps for Google analytics tracking id and name creation:- 1) Open google analytics page using https://www.google.com/analytics/web/ this URL. 2) Create admin tab on top. You'll find 3 sections, Account, Property and View. Click Account drop down and select "Create New Account". 3) Click "Mobile App" tab. Fill all details and click "Create Tracking ID" at bottom. Accept terms of service 4) Now copy Tracking ID from the result shown on the page and paste in "Tracking Id" in "GOOGLE_ANALYTICS" settings under "THIRD PARTY APPLICATIONS" and in "Tracking Name" field enter the app name you have provided for creation of Tracking ID in google analytics admin.

Add or edit event

This action is for adding new event to calendar app or editing existing event (which was added earlier using same action) with details provided in parameters. On success “Calendar Event Added Or Edited” event will be triggered, so any actions you want to perform on success can be configured in “Calendar Event Added Or Edited” event listed in ”ACTION(S)” tab of the control on which you are configuring “Add or edit event” action. Response parameter for “Calendar Event Added Or Edited” event is "event_identifier" of event added or edited. If you set "Identifier" parameter existing event will edited and saved with new details provided in parameters. Else new event will be added with details provided in parameters.

Add or Edit Reminder

This action is for adding new reminder for a task to reminders app or editing existing reminder (which was added earlier using same action) with details provided in parameters. On success “Reminder Added Or Edited” event will be triggered, so any actions you want to perform on success can be configured in “Reminder Added Or Edited” event listed in ”ACTION(S)” tab of the control on which you are configuring “Add or Edit Reminder” action. Response parameter for “Reminder Added Or Edited” event is "event_identifier" of reminder added or edited. If you set "Identifier" parameter, existing reminder will edited and saved with new details provided in parameters. Else new reminder will be added with details provided in parameters.

Add Pin On Map

This action is for adding pin at a location on map view control.

Audio Recording

This action is used for audio recording operations. Like start recording, stop recording, play recorded audio, pause, stop etc. You need to use "Start Recording" and then "Stop Recording" actions to save audio recording. Audio will be start recording once "Start Recoding" is used until "Stop Recording" action is called. Saved file can be accessed in path saved using "temp_audio_path" System session variable. After saving the audio recording, “Image Picked” event will be triggered, so any actions you want perform after saving audio recording can be configured in “Image Picked” event listed in ”ACTION(S)” tab of the control on which you are configuring “Audio Recording” action.

Back

Back action is for navigating user back to the screen or set of screens (contained in tab bar or side panel), from which user has been navigated to current screen. The screen from which user is navigating back will be removed from “navigation stack” (for more information on navigation stack please refer to redirect action documentation). Every time you use a redirect action, new screen would be added to navigation stack and when back action is triggered, current screen would be removed from “navigation stack”. If current screen is the first screen of app, back action will not work.

Barcode

This action is for bar code scanning. A bar code reader view will be presented to user for scanning bar code. On successful scanning "Barcode Success" event will be triggered so any actions you want perform after successful scanning, can be configured in “Barcode Success” event listed in ”ACTION(S)” tab of the control on which you are configuring “barcode” action. Scan results can be retrieved as response parameters of “Barcode Success” event. Following are the response parameters:- BarCodeImage BarCodeText If user cancels the scanning process "Barcode Cancel" event will be triggered so any actions you want perform on cancel can be configured in "Barcode Cancel" event listed in ”ACTION(S)” tab of the control on which you are configuring “barcode” action.

Call

Call action is for showing call prompt to the user if they wish to call a number.

Capture View Screenshot

This action is used to take screenshot of given view and set to the image view.

Change Language

This action is for changing application language.

Change Map Center

This action used to change the center of the selected map view

Change Object Properties

This action is for changing a certain property value for applicable control e.g text for label control, image for image view control etc

Change Street View

This action is for changing street view currently being displayed on map. Street view is feature only available in google maps. Street view users to explore the world through 360-degree street-level imagery. Google maps can be enabled either in "Map" settings in "MISCELLANEOUS SETTINGS" tab for application scope i.e, for using google maps in whole application (for more information refer to "Map" settings documentation) or enabling "Enable Street View" property on map control i.e, for using google map for that particular map only.

Change Tabbar Properties

This action is for changing TabBar properties. You can select the type of property from "TabBar Property" parameter drop down and associated values from other parameters.

Change Table Properties

This action is for reloading table view, grid view or photo animated gallery detail control data depending on parameters you set. You can select the type of reload from "Reload Type" parameter drop down and associated values from other parameters.

Change Theme

To change application theme

Copy To Clipboard

This action facilitates to copy image or text to clipboard

Dismiss Custom Dialog

To dismiss Custom Dialog which is showing on Screen.Dialog will be dismiss based on the given Dismiss Model View . For Android it is optional. Dialog will be dismiss automatically which is showing on screen

Dropbox Core

Dropbox Core action is to access and manipulate user's dropbox account. You can select type of dropbox action to be performed from "Type" parameter. On Dropbox Core action success or failure “Dropbox Core Action Completed” event will be triggered, so any actions you want perform on success or failure, can be configured in “Dropbox Core Action Completed” event listed in ”ACTION(S)” tab of the control on which you are configuring “Dropbox Core” action. “success” is the response parameter of “Dropbox Core Action Completed” which indicates success or failure of sharing action. “success” value would be “1” on success and “0” on failure, add condition for checking “success” parameter value in order to configure actions for success and failure separately. This action will work only if you set "APP KEY" and "APP SECRET" in "DROPBOX" settings under "THIRD PARTY APPLICATIONS". Following are the steps for Dropbox app key and app secret creation:- 1) Open Dropbox console page using https://www.dropbox.com/login?cont=https%3A%2F%2Fwww.dropbox.com%2Fdevelopers%2Fapps this URL. 2) Login and click "Create app" and choose "Dropbox API app" and choose "Files and datasources" or "Datasources only" for the type of data you want to store on Dropbox. If you have selected "Datasources only", enter app name and click "create app" or if you have selected "Files and datasources", select "YES" if you want to access only files created by you app or "NO" to access all files on user's dropbox account. (NOTE:- if you have selected "YES", set "NO" and if you have selected "NO", set "YES" in "Drop Box Should Be Root Folder" option in "DROPBOX" settings under "THIRD PARTY APPLICATIONS") after access selection enter your app name and click "create app" 3) Now copy "App key" and "App secret" from the result shown on the page and paste in "APP KEY" and "APP SECRET" respectively in "DROPBOX" settings under "THIRD PARTY APPLICATIONS".

Edit Contact

This action is for editing contact of address book with details provided in parameters. On successfully saving the changes for contact “Phone Contact Edited” event will be triggered, so any actions you want perform after editing contact can be configured in “Phone Contact Edited” event listed in ”ACTION(S)” tab of the control on which you are configuring “Edit Contact” action. Details of edited contact can be retrieved as response parameters of Phone Contact Edited” event. Following are the response parameters:- PersonIndex First Last full_name address_first Address email_first Email phone_first Phone Date Instant Message Profile Related People URL ThumbNailImage thumbImagePath OriginalImage

Email

Email action is for presenting mail composition interface to the user, with initial recipients, subject, body, CC recipients and BCC recipients populated from the parameters you provide. You can configure actions to be fired when Email is sent, cancelled by user, was saved in drafts or failed events, in “Email Sent”(Email sent successfully), “Email Cancelled”(Email was cancelled by user), “Email Saved”(if Email is saved in drafts and not sent) and “Email Failed”(Email sending failed due to some error) respectively listed under ”ACTION(S)” tab of same control for which you are configuring “Email” action.

Facebook

Facebook action is for presenting a Facebook sharing view pre filled with sharing text, URL and image provided in action parameters. After presenting the view, user can edit the post before sharing or choose to post the same and can even cancel the post. On Sharing success or failure “Sharing Done” event will be triggered, so any actions you want perform on success or failure, can be configured in “Sharing Done” event listed in ”ACTION(S)” tab of the control on which you are configuring “Facebook” action. “success” is the response parameter of “Sharing Done” which indicates success or failure of sharing action. “success” value would be “1” on successful sharing and “0” on failure, add condition for checking “success” parameter value in order to configure actions for success and failure of sharing separately.

Google+

Google+ action is for presenting a Google+ sharing view pre filled with sharing text, URL, image and title provided in action parameters.The Share dialog provides a means for users to share rich content from your app into the Google+ stream, including text, photos, and URL attachments. After presenting the view, user can edit the post before sharing or choose to post the same and can even cancel the post. On Sharing success or failure “Sharing Done” event will be triggered, so any actions you want perform on success or failure, can be configured in “Sharing Done” event listed in ”ACTION(S)” tab of the control on which you are configuring “Google+” action. “success” is the response parameter of “Sharing Done” which indicates success or failure of sharing action. “success” value would be “1” on successful sharing and “0” on failure, add condition for checking “success” parameter value in order to configure actions for success and failure of sharing separately. Google+ share action will work only if you set "Google Plus Client Id" in "GOOGLE+" settings under "THIRD PARTY APPLICATIONS". Following are the steps for Google+ client id creation:- 1) Open google developer console using https://console.developers.google.com/ this URL. 2) Create a project with your application name and agree to google terms of service. 3) Select your recently created project from the list of projects your projects. Click APIs & auth section and select APIs from the list. Under Social APIs, select Google+ API. After Selecting click on Enable API. Enable any other google services you want to use in your application same as you did for Google+ API. 4) Now come back and select Credentials user APIs & auth section of same project. Click on Create new Client ID, a dialog will be opened select Installed application option, a dialog will be opened select Android/iOS option. 5) If you have selected Android enter your application certificate fingerprint, package name in the dialog and if you want to enable deep linking, then select Enable in the Deep Linking section of the dialog or if you have selected iOS key enter your application bundle identifier, app store id (if any) and if you want to enable deep linking, then select Enable in the Deep Linking section of the dialog and click Create Client ID. 6) Now copy Client ID from the result shown on the page and paste in "Google Plus Client Id" in "GOOGLE+" settings under "THIRD PARTY APPLICATIONS".

Hide Soft Keyboard

Hide visible soft keyboard.

Hide Street View

This action is for hiding street view on map, which was either shown earlier using "Change Street View" action or on map enabling "Enable Street View" property. Street view works only for google maps. Google maps can be enabled either in "Map" settings in "MISCELLANEOUS SETTINGS" tab for application scope i.e, for using google maps in whole application (for more information refer to "Map" settings documentation) or enabling "Enable Street View" property on map control i.e, for using google map for that particular map only. For more information about street view refer to "Change Street View" action.

INSTAGRAM

Instagram action is for redirecting user to Instagram app(if installed) sharing view pre filled with image and caption provided in action parameters. After redirecting to Instagram app user can edit the post before sharing or choose to post the same and can even cancel the post. On Sharing success or failure “Sharing Done” event will be triggered, so any actions you want perform on success or failure, can be configured in “Sharing Done” event listed in ”ACTION(S)” tab of the control on which you are configuring “INSTAGRAM” action. “success” is the response parameter of “Sharing Done” which indicates success or failure of sharing action. “success” value would be “1” on successful sharing and “0” on failure, add condition for checking “success” parameter value in order to configure actions for success and failure of sharing separately. INSTAGRAM share action will work only if you set "Client ID" and "Redirect URL" in "INSTAGRAM" settings under "THIRD PARTY APPLICATIONS" and Instagram app is installed on user device. Following are the steps for Instagram client id and redirect URL creation:- 1) Open Instagram authentication page using https://instagram.com/developer/authentication/ this URL. 2) Login and click "Manage Client" to create new Instagram client.Click on "Register a New Client". 3) Enter you application name, description and website address. Website address you have entered is you redirect URL so keep a note of it. 4) Enter captcha and click "Register". 5) Now copy "CLIENT ID" and "REDIRECT URI" from the result shown on the page and paste in "Client ID" and "Redirect URL" respectively in "INSTAGRAM" settings under "THIRD PARTY APPLICATIONS".

Linked In

Linked In action is for sharing on user's linked in account on behalf of user. On Sharing success or failure “Sharing Done” event will be triggered, so any actions you want to perform on success or failure, can be configured in “Sharing Done” event listed in ”ACTION(S)” tab of the control on which you are configuring “Linked In” action. “success” is the response parameter of “Sharing Done” which indicates success or failure of sharing action. “success” value would be “1” on successful sharing and “0” on failure, add condition for checking “success” parameter value in order to configure actions for success and failure of sharing separately.

Manage Audio Player

To manage Audio player functions. Pause Resume Stop Seek To Track Position (Seeks to specified time position of track). For the current version version this action is compatible with Android Platform Only.

Open Custom Screen

Open Image Editor

This action is for presenting user with image editor view where image can be edited using basic image editing features like adding filter, cropping, rotating, color and brightness adjustment etc.

Open Share Activity

This action is for presenting activity controller to user. Activity controller provides a unified services interface for sharing and performing actions on data within an application. You need to provide text, image and URL to be shared or performed actions on. User can select from set of sharing and action services shown activity controller. Sharing services include the following:- 1) Message 2) Mail 3) Facebook 4) Twitter 5) Google+ 5) Flickr 6) Vimeo 7) TencentWeibo 8) Weibo Action services include the following 1) Print 2) CopyToPasteboard 3) AssignToContact 4) SaveToCameraRoll 5) AddToReadingList 6) AirDrop

Open URL

Open URL action is for opening a website with given URL address for user, either in in app browser or safari app.

Play Audio

This action to play audio . Audio will be played in Foreground only.

Play Video

This action is for playing local or online video. User will be presented with a screen playing video and controls for user to play/pause, view full screen, done, slider for forwarding the video. For playing a local video file, you need to upload the video file to assets manager and provide name of the video file in "Video Url" parameter. If you want to play online video (youtube or other source), you need to provide video URL in "Video Url" parameter.

Rate APP

This action is for reminding users to review your app on App Store. This action will work only if your app is on App Store and and you need to set you app’s app id in APP_RATER section THIRD PARTY APPLICATIONS settings.

Redirect

Redirect action is for navigating user from one screen to another screen or set of screens(contained in tab bar or side panel) with an optional animation. The screens by a navigation interface typically mimic the hierarchical organization of your data. At each level of the hierarchy, you can provide an appropriate screen to display the content at that level. The currently displayed screens are managed internally using “navigation stack”, which is represented by an array of screens. The screen which user is navigating to, will added to the end of navigation stack(array) and the app's initial screen would be the first object of navigation stack. Every time you use a redirect action new screen would be added to navigation stack and when back action(for more information refer to back action documentation) is used screen would be removed from “navigation stack”.

Remove Animation

This action is for removing view with animation.

Remove Reminder

This action is for removing a reminder, which was added earlier using "Add or Edit Reminder" action to reminders app. On success “Reminder Removed” event will be triggered, so any actions you want to perform on success can be configured in “Reminder Removed” event listed in ”ACTION(S)” tab of the control on which you are configuring “Remove Reminder” action.

Remove Session

This action for removing a value which was saved earlier using “Save in Session Permanently” or “Save in Session Temporarily”.

Save Image To Album

This action is for saving an image( or Any file in Android ) to album on device. On saving image(File) to the album "Saved To Album" event will be triggered. so any actions you want perform on save can be configured in “Saved To Album” event listed in ”ACTION(S)” tab of the control on which you are configuring “Save Image To Album” action. For Android Platform it will support to save any type of file in device/sdcard storage.

Save in Session Permanently

This action for saving a value with a key (key name for future reference) permanently. Once you save a value in session you can use it any screen of the app, selecting source as “Session” from parameter source drop down available in some action parameters and web service parameters. The value you save using this action will appear under “UserDefined” section from the drop down, next to the source options drop down.When you save value using this action it will be available until app is uninstalled or deleted by the user.

Save in Session Temporarily

This action for saving a value with a key (name for future reference) temporarily. Once you save a value in session you can use it in any screen of the app selecting source as “Session” from parameter source drop down available in all action parameters and web service parameters. The value you save using this action will appear under “UserDefined” section from the drop down. Saved session value will be available until app is quit by the user(app is not running either in foreground or background).

Set Badge Number On Application Icon

This action is for setting number that has to be set as badge of the application icon in Springboard. Badge is usually a red circle on top right corner of the application icon, with a number in the middle.

Set Timer

"Set Timer" action is for starting a timer, with two parameters "Fire Interval (in seconds)" and "Should Repeat". "Fire Interval (in seconds)" parameters is for setting time interval in seconds at which timer has to be fired and "Should Repeat" parameter is a boolean parameter indicating whether timer has to be repeated for every "n" seconds set in "Fire Interval (in seconds)" or not. "Timer Fired" event will be triggered whenever timer is fired. This event will be fired for every "n" seconds set in "Fire Interval (in seconds)" parameter if "Should Repeat" parameter is set to "YES" and if "Should Repeat" parameter is set to "NO", "Timer Fired" event will be triggered only once after "n" seconds set in "Fire Interval (in seconds)" parameter.

Show ActionSheet

This action is for displaying action sheet to the user. Action sheet is to present the user with a set of alternatives for how to proceed with a given task. You can also use action sheets to prompt the user to confirm a potentially dangerous action. The action sheet contains one or more buttons, each of which corresponds to an action to take. You can set action sheet button titles or images using parameters of this action. When user taps a button on action sheet, “Action Sheet selected” event will be triggered, so any actions you want perform when action sheet button is tapped can be configured in “Action Sheet selected” event listed in ”ACTION(S)” tab of the control on which you are configuring “Show ActionSheet” action. “seletedButtonIndex” is the response parameter of “Action Sheet selected” which indicates which button is tapped by user. Add condition for checking value of “seletedButtonIndex” response parameter value in order to configure actions for each button of action sheet separately. Following are the response parameter for "Action Sheet selected" event :- 1)selectedButtonIndex :- Index of the tapped button 2)selectedTitle :- Title of the tapped button

Show Alert

This action is for displaying alert view to the user. Alert View is for displaying the user with an alert message or take input form user to perform certain task. You can also use alerts to prompt the user to confirm an action. When user taps a button on alert view, “Alert Button Click” event will be triggered, so any actions you want perform when alert button button is tapped can be configured in “Alert Button Click” event listed in ”ACTION(S)” tab of the control on which you are configuring “Show Alert” action. “seletedButtonIndex” and "selectedButtonTitle" are the response parameters of “Alert Button Click” which indicates which button is tapped by user. Add condition for checking value of “seletedButtonIndex” or "selectedButtonTitle" response parameter value in order to configure actions for each button of alert view separately. You can access user input in alert view text fields using "alert_text_1" and "alert_text_2" response parameters in case of alert type is "SecureTextInput", "PlainTextInput" or "LoginAndPasswordInput" Following are the response parameters for "Alert Button Click" event :- 1) selectedButtonIndex :- Index of the tapped button 2) selectedButtonTitle :- Title of the tapped button 3) alert_text_1 :- Text entered by user in text field one. If alert type is "SecureTextInput", "PlainTextInput" or "LoginAndPasswordInput" 4) alert_text_2 :- Text entered by user in text field two(password). If alert type is "LoginAndPasswordInput"

Show Contacts

This action is for showing phone contacts list to user from which, a contact can be selected. And on contact selection, contacts list screen will be dismissed and user will be shown current screen on which phone contacts screen was presented. On selection of contact “Phone Contact Selected” event will be triggered so, any actions you want perform on contact selection can be configured in “Phone Contact Selected” event listed in ”ACTION(S)” tab of the control on which you are configuring “Show Contacts” action. Details of selected contact can be retrieved as response parameters of “Phone Contact Selected” event. Following are the response parameters:- PersonIndex First Last full_name address_first Address email_first Email phone_first Phone Date Instant Message Profile Related People URL ThumbNailImage thumbImagePath OriginalImage

Show Custom Dialog

To show custom dialog using Model View Only.Custom View in dialog. It will display Single Dialog at a time.

Show Direction On Map

This action is for showing direction path between two locations on map view control. On directions success or failure “Directions Added” event will be triggered, so any actions you want perform on success or failure, can be configured in “Directions Added” event listed in ”ACTION(S)” tab of the control on which you are configuring “Show Direction On Map” action. “success” is the response parameter of “Directions Added” which indicates success or failure of this action. “success” value would be “1” on successful path calculation and “0” on failure, add condition for checking “success” parameter value in order to configure actions for success and failure of directions separately

Show Full Screen Ad

This action will show Interstitial Ad

Show Image Picker

This action is for enabling user to select image, video or audio from device or record new video, audio or capture image from the device. On successful completion of action "Image Picked" event will be triggered with appropriate response parameters based on parameters you set for this action. Any actions you want perform on completion of this action, can be configured in “Image Picked” event listed in ”ACTION(S)” tab of the control on which you are configuring “Show Image Picker” action.

Show PopOver Controller

Use this to display screen in popover controller. Works only for iPad

Side Panel Properties

This action is for handling side panel related actions like show/hide left or right panel screens, change center panel screen etc.

SMS

SMS action is for presenting message composition interface to the user, with initial recipients and body populated from the parameters you provide. You can configure actions to be fired when SMS is sent, cancelled or failed events in “SMS Sent”(SMS sent successfully), “SMS Cancelled”(SMS was canceled by user) and “SMS Failed” (SMS sending failed due to some error) respectively listed under ”ACTION(S)” tab of same control for which you are configuring “SMS” action.

Start Location

This action starts generation of updates that report the user’s current location. If user location is successfully updated, “Location Success” event will be fired so, any actions you want to perform after location update, can be configured in “Location Success” event listed in ”ACTION(S)” tab of the control to which you are configuring “Start Location” action. If location update has failed, “Location Error” event will be fired, so, any actions you want perform on location updated failure can be configured in “Location Error” event. Note :- User location tracking is a time taking process, so it is recommended to use this action in first of the app (e.g, splash screen), so that user location details will be available when required. If location is updated successfully you can get location details from session keys drop down under “System” section :- current_location_latitude current_location_longitude current_location_address current_location_state current_location_country current_location_postal_code

Stop Location

This action stops updating user’s current location, which was initiated earlier using “Start Location” action.

Stop Timer

"Stop Timer" action is for stopping timer which was activated earlier using "Set Timer" action. There are no parameters for this action. "Timer Fired" will not be triggered anymore if this action is called.

Trigger Data Source (API Call)

WS Call action is for calling a web service URL to download or upload data.

Trigger Local Datasource (Local API Call)

DB Call action is for executing local database query(insert, update, delete or select)

Twitter

Twitter action is for presenting a twitter sharing view pre filled with sharing text, URL and image provided in action parameters. After presenting the view, user can edit the post before sharing or choose to post the same and can even cancel the post. On Sharing success or failure “Sharing Done” event will be triggered, so any actions you want perform on success or failure, can be configured in “Sharing Done” event listed in ”ACTION(S)” tab of the control on which you are configuring “Twitter” action. “success” is the response parameter of “Sharing Done” which indicates success or failure of sharing action. “success” value would be “1” on successful sharing and “0” on failure, add condition for checking “success” parameter value in order to configure actions for success and failure of sharing separately.

WhatsApp Share

WhatsApp Share action is for sending text/image to user's whatsapp contact(s) on behalf of user. On Sharing success or failure “Sharing Done” event will be triggered, so any actions you want to perform on success or failure, can be configured in “Sharing Done” event listed in ”ACTION(S)” tab of the control on which you are configuring “WhatsApp Share” action. “success” is the response parameter of “Sharing Done” which indicates success or failure of sharing action. “success” value would be “1” on successful sharing and “0” on failure, add condition for checking “success” parameter value in order to configure actions for success and failure of sharing separately.