rbv_api.setOptions()

Purpose

This method configures the options such as async, etc., on the global level. The options are applied within the formula or trigger code. Make sure this method is used in conjunction with rbv_api.attach() or rbv_api.detach() method.

Syntax

rbv_api.setOptions(async)

async

When set to true, large data operations like List view export, Tabular report export, Mass update or Status update are processed asynchronously in the background.

If false, the entire operation is processed synchronously.

Permissions required

Edit permission for the selected object types.

Example

In the following examples, ensure the method rbv_api.attach is used along with the setOptions method, with either async option set to true or false.

With async option set to true:

rbv_api.setOptions({async: true});
rbv_api.attach(relName, objName1, Id1, objName2, Id2)

With async option set to false:

rbv_api.setOptions({async: false });
rbv_api.attach(relName, objName1, Id1, objName2, Id2)