Actions

Actions let you execute different functionality in your app. Actions can be applied to many of the available Components such as Buttons, Touchable, Fetch, List, and more. They can also be executed from Screens.

Actions are combined into Workflows which are assigned to Triggers from the Interactions tab for a component. The Triggers that are available will depend on the component that is selected. For instance, a Button has an On Press Trigger, but a List doesn't.

Clicking on a Trigger in the Interactions tab will open up the Action Editor for that Trigger. Here you can add as many Actions as you need.

API Request

Make an API request using one of your configured REST API Services and Endpoints.

Endpoint Setup

Example response with Parse JSON disabled:

{
    "result": {
        "status": 200,
        "statusText": "OK",
        "text": "[YOURDATA]"
    }
}

Configuration

If your selected Endpoint has parameters, they will show up here so you can assign values to them.

Conditional Stop

When the value evaluates to true, no further actions will be performed.

Extract Key

📘

Consider using Keypath transform instead

Most of the time, you can avoid using the Extract Key Action and instead type the keypath directly into the transform input where available. Learn more about it in the Transform Functions docs.

Chained with API Request action. Use this action to extract a key from an object or array.

To construct the Path, use dot (.) or square bracket notation ([]) to traverse deeply nested objects.

For example, use .fields.Name to extract the value of Name from the following object:

{ 
  "fields": { 
    "Name": "Some Value" 
  } 
}

Refetch Data

Refetches data of a given Fetch component.

• The component that triggers this Action must be nested inside the Fetch component.
• The Endpoint you are re-fetching the data for, needs to have a Role and an Object type configured.

Endpoint Setup

Set Variable

Set the value of one or more Screen, App, or Device Variables. Can also be used to update a variable declared within an Action workflow (see Declare Variable below)

Declare Variable

Create a local variable that is scoped to the selected Trigger. Used for temporary values needed during the current Action flow. Use Set Variable to update a declared variable within an Action workflow.

If/Else

Add a branch to your logic flow to execute different Actions based on the value of a boolean Variables.

Navigate

Navigate to a Screen, Tab Navigator, or Stack Navigator, optionally Passing Data.

Navigation Setup

Pass Data

If the destination you select accepts Navigation Params, they will be available here so you can pass values to them.

Navigating with Route Data

The Navigate Action includes an option for the Destination prop named Custom Destination. When selected, it will enable two additional parameters - Route Name and Params.

You can pass the name key from the route data to the Route Name prop and include any navigation params.

Navigate Back

Navigates back to the previous Screen by removing the current Screen from the navigation history.

Open App Link

Accepts a URL Scheme to open links to other applications. For example, you can open the telephone, messages, maps, or the browser.

On iOS and Android, this will take users out of your application and into another, exiting your application. You can only open an application that the local system supports.

Common URL Schemes

Google Maps

If Google Maps is installed on the user's device, the Google Maps application will open. If it isn't installed, Google Maps will open in the browser. Check the Google Maps Developer Guide for more information on constructing valid URLs.

URL with Search Query

Launch Google Maps with a list of locations that match the query with the closest one being pinned.
https://www.google.com/maps/search/?api=1&query=Shake+Shack

URL with Directions

Launch Google Maps with directions to the location defined in the URL from the user's current location.
https://www.google.com/maps/dir/?api=1&destination=Shake+Shack+66+E+Ohio+St+Chicago+IL

URL with Simple Map

Launch a blank map with the user's location highlighted.
https://www.google.com/maps/@?api=1&map_action=map

URL with Street View

Launch a Street View panorama of the selected location.
https://www.google.com/maps/@?api=1&map_action=pano&viewpoint=48.857832,2.295226&heading=-45&pitch=38&fov=80

Open Browser

This action allows you to open any http:// or https:// URL in the systems web browser.

On iOS and Android this will open the URL and when the user is finished will return them to the application. On the web, this will open the URL in a new window.

Dismiss Browser

This action allows you to dismiss the browser that was opened by the Open Browser action.

Open Camera

Opens a device's Camera to take a picture or record a video. Returns image or video data in base64-encoded string format or an Asset object.

Asset Object

{
    "assetId": null,
    "mimeType": "image/jpeg",
    "duration": null,
    "fileSize": 261949,
    "height": 4032,
    "type": "image",
    "uri": "file:///var/mobile/Containers/Data/Application/.../Library/Caches/ImagePicker/filename.jpg",
    "width": 3024,
    "base64": null,
    "exif": null,
    "fileName": null
}

Open Image Picker

Opens a device's media library to select a photo or a video. Returns image or video data in base64-encoded string format or an Asset object.

Asset Object

{
    "assetId": null,
    "mimeType": "image/jpeg",
    "duration": null,
    "fileSize": 261949,
    "height": 4032,
    "type": "image",
    "uri": "file:///var/mobile/Containers/Data/Application/05219D0E-2521-47A4-B2A5-42E2ACF93F03/Library/Caches/ImagePicker/2539866A-5901-4054-9C42-3520BDA5600C.jpg",
    "width": 3024,
    "base64": null,
    "exif": null,
    "fileName": null
}

Open Share Dialog

This action allows you to open the native share dialog and share text or URLs with other apps. Not all apps support the share feature and may not be listed in the available apps to share with.

Update Map Location

Updates the current location of a Map View component. This Action requires a Map View component on the Screen to reference.

Re-Center Map

Re-centers the map around a the Initial Latitude and Initial Longitude prop coordinates. (Requires a Map View component).

Dismiss Keyboard

Dismisses the active keyboard and removes focus from any inputs.

Select File

Opens the device's native file picker. Returns file data in base64-encoded string format.

Example response with name

{
  name:"MyTextFile.txt",
  value:"data:text/plain;base64,WwoJewoJCSJsYWJlbCI6ICJSZWQi...CgoKCg=="
}

Example response without name

"data:text/plain;base64,WwoJewoJCSJsYWJlbCI6ICJSZWQi...CgoKCg=="

Asset Object

{
    "assetId": null,
    "mimeType": "image/jpeg",
    "duration": null,
    "fileSize": 261949,
    "height": 4032,
    "type": "image",
    "uri": "file:///var/mobile/Containers/Data/Application/05219D0E-2521-47A4-B2A5-42E2ACF93F03/Library/Caches/ImagePicker/2539866A-5901-4054-9C42-3520BDA5600C.jpg",
    "width": 3024,
    "base64": null,
    "exif": null,
    "fileName": null
}

Show Alert

Displays a native device alert to the user. The button can currently only be used to dismiss the alert.

⚠️

Only Message is displayed on Web.

Focus Text Input

Focuses the selected input component, such as a Text Input, Number Input, PIN Input component, and opens the virtual keyboard on mobile devices. Requires a compatible component to be present on the Screen to add to a workflow.

Get Expo Push Token

Returns an Expo Push Token as a string for sending push notifications with Expo's push service. Learn more about sending and receiving push notifications in your Draftbit app in the Push Notification docs.

Get Location

Requests permissions and then returns an object with location information for the device

Location object

The location object returned by the Get Location Action contains the following data object:

{  
    coords: {  
        accuracy: 20.6185685750211,  
        altitude: 43.04912245369878,  
        altitudeAccuracy: 6.938014590198416,  
        heading: 180.40493651139974,  
        latitude: 30.747315,  
        longitude: -85.088285,  
        speed: 0  
    },  
    timestamp: 1634698876011.571  
}

Get Notification Count

Returns the number currently set as the notification count for the app. Usually displayed on the apps device icon. A 0 value means that the badge is not displayed. See more about push notifications in the Push Notification docs.

Set Notification Count

Sets the number of notifications count for the app Usually displayed on the app's device icon. Setting it to 0 clears the badge. Returns true when successful, and false otherwise. See more about push notifications in the Push Notification docs.

Seek Media Position

Moves the play head to the designated position of the playing media in milliseconds. Requires an Audio or Video component on the Screen.

Toggle Media Playback

If the selected Audio or Video component is playing, it will pause the media. If the media is paused, it will resuming playback. Requires an Audio or Video component on the Screen.

Pause Media

Pauses the media of the selected component. Requires an Audio or Video component on the Screen.

Play Media

Plays the media of the selected component. Requires an Audio or Video component on the Screen.

Toggle Video Fullscreen

Toggles full-screen view for the selected Video component. Requires a Video component on the Screen.

Log to Console

Similar to the browser console and used as a debugging tool. You can pass a value, such as the result of another Action or a variable and it will be printed to the console log. The console logs are located in the bottom drawer of the Builder. Learn more in the Console Logs doc.

Run a Custom Function

Run Functions that you've created, optionally passing data, and get the results.

Function Setup

Arguments

If the function you are running has parameters, they will be listed here and you can pass values as arguments.

Haptic Feedback

Provides access to the system's vibration effects on Android and the haptics engine on iOS.

Wait

Add a delay before executing further Actions in the Workflow

Scroll To

Scrolls to a given x, y offset of a Scroll View, either immediately or with a smooth animation.. Requires a Scroll View component to be on the Screen.

Scroll To End

Scrolls to the end of the content in a List or Scroll View. Requires a a List or Scroll View component to be on the Screen.

Scroll To Index

Scrolls to the item in a List at the specified index so that it is positioned in the viewable area. Requires a List component to be on the Screen.

Expand Bottom Sheet

Snap to the maximum provided snap point. Requires a Bottom Sheet component to be on the Screen.

Collapse Bottom Sheet

Snap to the minimum provided snap point. Requires a Bottom Sheet component to be on the Screen.

Close Bottom Sheet

Fully closes the Bottom Sheet. Requires a Bottom Sheet component to be on the Screen.

Snap To Bottom Sheet Index

Snap to one of the provided snap points. Requires a Bottom Sheet component to be on the Screen.

Start Timer

Starts the selected Timer. Requires a Timer component to be on the Screen.

Stop Timer

Stops the selected Timer. Requires a Timer component to be on the Screen.

Reset Timer

Reset the selected Timer back to its Initial Time. Requires a Timer component to be on the Screen.

Toggle Drawer

Opens or closes the Drawer Navigator depending on its current state

Swipe Next

Swipe to the next item in a Swiper. Requires a Swiper component to be on the Screen

Swipe Previous

Swipe to the previous item in a Swiper. Requires a Swiper component to be on the Screen

Swipe To

Swipe to a specific item in a Swiper. Requires a Swiper component to be on the Screen

Swipe Card

Swipes the top card within a Deck Swiper. Requires a Deck Swiper to be on the Screen.

Change Theme

Changes the Theme applied to the app's UI for the user's device.

Set Color Scheme

Forces the app to use light or dark mode regardless of device setting. Useful when you have both dark and light versions of Themes.

Request Review

Ask the user to rate/review your app. Launches a native window/modal when available, otherwise falls back to provided store URLs. Web has no native or default review functionality, the 'Web Review URL' allows you to redirect 3rd party services that allow site reviews. Note: This action cannot be tested on Draftbit preview and will only work on exported and built apps.