Assistudio

One of the following error codes:

- `couldNotOpenURLError`: Triggered if the URL could not be opened.

error

Error

Open URL

Tap component

Alert

Set page variable

Delay

If condition

Open page

record

Record

One of the following error codes:

- `requestFailed`: Thrown if the entire request failed due to e.g. CORS issues or no network connectivity.
- `serverError`: Thrown if the server returned an error response.
- `resourceNotFound`: Thrown if the resouce you are trying to get was not found.
- `unknown`: Thrown if an unknown error occurred while fetching the record.
- `responseMustBeObject`: Thrown if the server does not return an object as a response for a single data record request.

Get record

Object containing the current user information after the session was validated.

currentUser

Access token used to access AppGyver-hosted cloud resources, such as databases or integrations.

Username for the logged-in user, typically an email address

Current user

One of the following error codes:

- `currentUserNotFound`: Thrown if the device did not have a session for the current user stored in the on-device storage.

Get current user (AppGyver Auth)

Object containing the current user information.

One of the following error codes:

- `authFailed`: Thrown if the authenticating the user failed.

Authenticate user (AppGyver Auth)

One of the following error codes:

- `unknown`: Thrown if an unknown error occured while invalidating the backend session.

Invalidate backend session (AppGyver Auth)

True/false value describing if the session is valid or not.

sessionValid

Session valid

Validate current session (AppGyver Auth)

Hide component

Hide spinner

Response returned by the data resource after the record is successfully created.

response

Response

One of the following error codes:

- `requestFailed`: Thrown if the entire request failed due to e.g. CORS issues or no network connectivity.
- `serverError`: Thrown if the server returned an error response.
- `resourceNotFound`: Thrown if the resouce you are trying to get was not found.
- `unknown`: Thrown if an unknown error occurred while creating the record.

Create record

Dismiss initial view

Show spinner

Response returned by the data resource after the record is successfully updated.

One of the following error codes:

- `requestFailed`: Thrown if the entire request failed due to e.g. CORS issues or no network connectivity.
- `serverError`: Thrown if the server returned an error response.
- `resourceNotFound`: Thrown if the resouce you are trying to get was not found.
- `unknown`: Thrown if an unknown error occurred while updating the record.

Update record

GPS position of the device when the flow function was called.

value

Accuracy of the `latitude` and `longitude` parameters, in meters.

Altitude of the device, in meters, relative to sea level. If the device does not provide this information, this value will be `null`.

Accuracy of the `altitude` parameter, in meters.

The direction in which the device is traveling, given as degrees from true north. 0 degrees represents true north, and the direction is determined clockwise (which means that east is 90 degrees and west is 270 degrees).

Latitude of the device, in decimal degrees.

Longitude of the device, in decimal degrees.

Velocity of the device, in meters per second.

ISO 8601 timestamp of when the value was read.

GPS position

One of the following error codes:

- `insecureProtocol`: Thrown when geolocation is being requested on web without using https protocol
- `unknown`: Thrown when calling the native API resulted in an unknown error.

GPS location

Response returned by the data resource after the record is successfully deleted.

One of the following error codes:

- `requestFailed`: Thrown if the entire request failed due to e.g. CORS issues or no network connectivity.
- `serverError`: Thrown if the server returned an error response.
- `resourceNotFound`: Thrown if the resouce you are trying to get was not found.
- `unknown`: Thrown if an unknown error occurred while deleting the record.

Delete record

Object representing the signature file drawn by the user.

signatureFile

Creation datetime of the file, if it can be determined.

MIME type of the file, if it could be determined.

Datetime when the file was last modified, if it can be determined.

Name of the file in the local filesystem, if applicable. Note that the filename and extension are included in the **Local path** property already.

Absolute local filesystem path representing the file location on the device, including the filename and extension. On web, this is created via the [`createObjectURL`](https://developer.mozilla.org/en-US/docs/Web/API/URL/createObjectURL) method.

Signature file

One of the following error codes:

- `platformNotSupported`: Thrown if the flow is used on a platform that is not supported
- `unknown`: Thrown if an unknown error occured while drawing the signature.

Draw signature

Remove local session (AppGyver Auth)

Object representing the captured photo file in the local filesystem.

photoFile

Photo file

One of the following error codes:

- `platformNotSupported`: Thrown if the flow is used on a platform, that is not supported
- `unknown`: Thrown when calling the native API resulted in an unknown error.

Take photo

Toast

One of the following error codes:

- `unknown`: Thrown if an unknown error occurred while previewing the PDF file.

Preview PDF

Vibrate

Return to initial view

Set data variable

Set app variable

The successfully retrieved collection of records.

records

Collection of records

Total count of records in the collection. Available only with driver-based resources that support total count.

totalCount

Total count

One of the following error codes:

- `requestFailed`: Thrown if the entire request failed due to e.g. CORS issues or no network connectivity.
- `serverError`: Thrown if the server returned an error response.
- `resourceNotFound`: Thrown if the resouce you are trying to get was not found.
- `unknown`: Thrown if an unknown error occurred while fetching the collection of records.

Get record collection

Object representing the captured video in the local filesystem

videoFile

Video file

One of the following error codes:

- `platformNotSupported`: Thrown if the flow is used on a platform, that is not supported
- `unknown`: Thrown if an unknown error occured while recording the video.

Record video

One of the following error codes:

- `unknown`: Thrown when calling the native API resulted in an unknown error.

Start geolocation poller

Configuration required by the data resource to delete a single data record.

request

Delete data record request

Configuration required by the selected data resource to get a single data record.

Get data record request

Configuration required by the selected data resource to get a collection of data records.

Get data record collection request

assignment

Data variable

componentId

View component

recordLabel

Record button label

cancelLabel

Cancel button label

stopLabel

Stop button label

Maximum duration for the recorded video, in seconds.

maxDuration

Video maximum duration

videoResolution

Video resolution

If `true`, include audio in the captured video.

captureAudio

Capture audio?

Interval, in ms, of how often the poller should fetch a new value.

updateInterval

Update interval

Maximum number of historical values to store under `sensorVars.geolocation.values`.

historySize

History size

If `true`, a GPS position will be requested. If set to `false`, a WIFI location will be requested.

enableHighAccuracy

High accuracy mode

Number of meters from the previous location to exceed before returning a new location. Set to `1` to not filter locations. Defaults to `1`

distanceFilter

Distance filter

Credentials object to send to the backend. For AppGyver Hosted Auth, this should always contain the `username` and `password` keys. For Cloud Auth, the credentials object can contain whatever is required by your integration.

credentials

Credentials

captureLabel

Capture button label

Camera type to open, either front or back.

cameraType

Camera type

Configuration required by the selected data resource to create a new data record.

Create data record request

URL to open

If `true`, the new value will also be stored into `sensorVars.geolocation.latestValue` and `sensorVars.geolocation.values`.

updateSensorVars

Update sensor variables

message

Toast message

The duration how long the toast will be shown, in millliseconds. Leave empty to show it indefinitely.

duration

Show duration

The position of toast showing on screen.

A negative number represents the distance from the bottom of screen.

A positive number represents the distance form the top of screen.

0 will position the toast to the middle of screen.

position

Toast position

Determines if the toast appears and disappears with a fade animation.

animation

Animates?

Determines if the toast dialog has a drop shadow around it.

shadow

Has shadow?

backgroundColor

Background color

shadowColor

Shadow color

textColor

Text color

Determines if the user can dismiss the toast dialog by pressing on it.

hideOnPress

Dismiss toast when pressed?

Opacity for the toast dialog. Must be between `0…1`.

opacity

Toast opacity

Configuration required by the selected data resource to update an existing data record.

Update data record request

Sets the target app variable to a new value.

variable

condition

Condition

page

Page

params

Parameters

If `true`, the page will be opened in a modal window.

openInModal

Open in modal?

Sets the target page variable to a new value.

Optional text label to show below the spinner. Subsequent calls to **Show spinner*** will update the text label, useful to e.g. show loading progress updates.

Global canvas