antaresEditObject (version 0.6.4)

setAPImode: Set API mode

Description

Two modes are available when using the API:

• async: record all API calls, but nothing is sent to the server

• sync: send query to the API each time a function is used

Usage

setAPImode(mode = c("sync", "async"), opts = antaresRead::simOptions())

Value

An updated list containing various information about the simulation.

Arguments

mode

The mode you want to use.

opts

List of simulation parameters returned by the function antaresRead::setSimulationPath()

Examples

if (FALSE) {
# See vignette for complete documentation
vignette("api-variant-management")

# Usage :
setAPImode("sync")

}