extensionRuntimeCode object

Specifies the location of code for the runtime. Based on runtime.type, add-ins can use either a JavaScript file or an HTML page with an embedded script tag that specifies the URL of a JavaScript file. Both URLs are necessary in situations where the runtime.type is uncertain.

Properties that reference this object type:

• root.extensions.runtimes.code

Syntax

Syntax

{
  "page": "{string}",
  "script": "{string}"
}

Schema

{
  "type": "object",
  "properties": {
    "page": {
      "$ref": "#/definitions/httpsUrl",
      "description": "URL of the .html page to be loaded in browser-based runtimes."
    },
    "script": {
      "$ref": "#/definitions/httpsUrl",
      "description": "URL of the .js script file to be loaded in UI-less runtimes."
    }
  },
  "additionalProperties": false,
  "required": [
    "page"
  ]
}

Properties

page

Specifies the URL of the web page that contains an embedded script tag, which specifies the URL of a JavaScript file (to be loaded in a browser-based runtime).

This property is localizable. For more information, see the localization schema.

Type
string

Required
✅

Constraints
Maximum string length: 2048.

Supported values
The string must start with https://.

script

Specifies the URL of the JavaScript file to be loaded in JavaScript-only runtime.

This property is localizable. For more information, see the localization schema.

Type
string

Required
—

Constraints
Maximum string length: 2048.

Supported values
The string must start with https://.

Remarks

For more information about the use of this property, see Add-in commands, Event-based add-in activation, and Copilot agents.

Examples

{
    "extensions": [
        {
          "runtimes": [
              "code": {
                "page": "https://contoso.com/events.html",
                "script": "https://contoso.com/events.js"
              }
          ]
        }
    ]
}