remove

Description

Removes certain data from a dataset.

Input / Parameter

Name	Description	Input Type	Default	Options	Required
dataset	The name of the dataset that is created in Services.	Text	-	-	Yes
filter	The filters to be applied.	FilterFormat	-	-	No
extra	The stored value that is passed to all the callbacks.	Any	-	-	No

FilterFormat (Object)

The format used for filtering in the parameter filter.

Key	Description	Input Type	Default	Options	Required
operator	Query operators used to filter multiple times.	Text	And	Or, And	No
data	Set of rules for another group of queries.	List	-	-	No

data (List)

Will contain a list of one (1) or more objects with the following structure (dataset, operator, value) and contain zero (0) or more objects with the same structure (FilterFormat only). This can be another FilterFormat to create grouped queries.

Key	Description	Input Type	Default	Options	Required
dataset	The dataset to filter.	Text	-	-	No
field	The field to be filtered.	Text	-	-	Yes
operator	Operators to be used for specific filtering.	Text	-	Equal, Not_Equal, Is_Null, Is_Not_Null, Greater_Than, Greater_Than_Or_Equal, Less_Than, Less_Than_Or_Equal, Like, Not_Like, In, Not_In, Between, Not_Between	Yes
value	The value to perform the query, which depends on the operator.	Any	-	-	No

Output

Description	Output Type
Returns the formatted information.	Object

Object

Key	Description	Output Type
success	Boolean value to denote whether the function was executed successfully.	Text
message	The message to print.	Text
data	Any additional message or data to print.	Text

Callback

callback

The action performed if this function runs successfully.

Description	Output Type
Returns a boolean value if data is deleted.	Boolean

errorCallback

The action performed if this function does not run successfully.

Description	Output Type
Returns an error message.	Text

Example

In this example, we will remove an item from the local table data from their local storage.

Note: This example will only work after the user has created the data using `Dataset.insert` function.

Steps

1. Create a Local Table in the services panel in the service page if there is no table created yet. For the fields, add nameand title as object key with Text type.

   
2. Drag a button component to a page in the mobile designer.

   
3. Select the event press and drag the Dataset.remove function to the event flow and fill in the parameter. Drag a Log.write function below the Dataset.remove function and change the parameter type of the value parameter to input.

   
4. For the filter parameter, change it's type to a function / subflow and drag Conversion.toObject to the subflow. Then add data as an object key and change it's type to a function / subflow. and put Conversion.toObject inside it.

   
5. Drag the function Conversion.toObject to the new subflow. Then add field, operator and value as object keys with name, like, n% as their values respectively.

   

Result

1. The data passed should be removed from the local table.