extensionGetStartedMessageArray object

Provides information used by the callout that appears when the add-in is installed.

Properties that reference this object type:

• root.extensions.getStartedMessages

Syntax

Syntax

{
  "requirements": {
    "capabilities": [
      {
        capabilities object
      }
    ],
    "scopes": [
      "mail | workbook | document | presentation"
    ],
    "formFactors": [
      "desktop | mobile"
    ]
  },
  "title": "{string}",
  "description": "{string}",
  "learnMoreUrl": "{string}"
}

Schema

{
  "type": "object",
  "properties": {
    "requirements": {
      "type": "object",
      "$ref": "#/definitions/requirementsExtensionElement"
    },
    "title": {
      "type": "string",
      "description": "The title used for the top of the callout.",
      "maxLength": 125
    },
    "description": {
      "type": "string",
      "description": "The description/body content for the callout.",
      "maxLength": 250
    },
    "learnMoreUrl": {
      "$ref": "#/definitions/httpsUrl",
      "description": "A URL to a page that explains the add-in in detail."
    }
  },
  "additionalProperties": false,
  "required": [
    "title",
    "description",
    "learnMoreUrl"
  ]
}

Properties

requirements

Type
requirementsExtensionElement

Required
—

Constraints

Supported values

title

The title used for the top of the callout.

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

Type
string

Required
✅

Constraints
Maximum string length: 125.

Supported values

description

The description/body content for the callout.

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

Type
string

Required
✅

Constraints
Maximum string length: 250.

Supported values

learnMoreUrl

A URL to a page that explains the add-in in detail.

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://.