Call a Function¶

On this page

Overview
Usage

Overview¶

You can call a function from other parts of your Realm app or from a connected client application.

Usage¶

The examples in this section demonstrate calling a simple function named sum that takes two arguments, adds them, and returns the result:

copy

// sum: adds two numbers
exports = function(a, b) {
  return a + b;
};

Call from Another Function¶

You can call a function from another function, including incoming webhooks and triggers, by accessing function context with the context.functions global variable:

For additional information, see the Function Context reference page.

copy

// difference: subtracts b from a using the sum function
exports = function(a, b) {
    return context.functions.execute("sum", a, -1 * b);
};

Call from a JSON Expression¶

You can call a function from a Realm JSON Expression, including service rules, by using the %function operator:

copy

{
  "numGamesPlayed": {
    "%function": {
      "name": "sum",
      "arguments": [
        "%%root.numWins",
        "%%root.numLosses"
      ]
    }
  }
}

Call from a Client Application¶

You can call a function from client applications that are connected with a Client SDK or over the wire protocol.

iOS SDK
Android SDK
JavaScript SDKs
Node.js SDK
React Native SDK

To execute a function from the iOS Client SDK, see the iOS SDK guide for calling a function.

To execute a function from the Android Client SDK, see the Android SDK guide for calling a function.

To execute a function from the Web Client SDK, see the Web SDK guide for calling a function.

To execute a function from the Node Client SDK, see the Node SDK guide for calling a function.

To execute a function from the React Native Client SDK, see the React Native SDK guide for calling a function.

← Define a Function Access Function Context →