eventtab.Cancel()

Syntax

void eventtab.Cancel(map event-to-cancel);

Parameters

Parameter	Type	Description
event-to-cancel	map	The row to be deleted from the synchronization events table, represented as a map object where the column name is the key and the field value is the value.

Returns

The method does not have a return value. The specified event will be removed from the synchronization events table, and will not be triggered when the designated user's mobile client synchronizes with the server.

Remarks

The method will fail with a Specified values did not identify a single event to delete in evtab... error message if zero or multiple rows match the event-to-cancel parameter.

Sample

The synchronization events table used in the sample below has two columns: one for the mobile user whose synchronization with the server will trigger the processing of the events in the sync events table, and one for an arbitrary string.

musketeers.evem

<Event Name="musketeers" xmlns="http://schemas.mobilengine.com/event/v1">
  <Columns>
    <Column Name="user" Type="Text" AgentName="true"></Column>
    <Column Name="musketeer" Type="Text"></Column>
  </Columns>
</Event>

The script that the submission of the cancel empty webform triggers will insert three new events into the musketeers synchronization events table, and then cancel one of them.

eventCancel.rfs

server program eventCancel for form cancel
using eventtab musketeers;
{
  events.musketeers.Create({user: form.info.user.name, musketeer: "Athos"});
  events.musketeers.Create({user: form.info.user.name, musketeer: "Porthos"});
  events.musketeers.Create({user: form.info.user.name, musketeer: "Aramis"});
  events.musketeers.Cancel({musketeer: "Porthos"});
}

Figure 422. Only two of the three musketeers show up as pending events on the Backoffice site

Developer Documentation

The eventtab type