Поделиться через


extensionGetStartedMessageArray object

Provides information used by the callout that appears when the add-in is installed in Excel, PowerPoint, or Word.

Properties that reference this object type:

Syntax

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

Properties

requirements

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.

Note

Currently, a bug prevents this property from rendering in the callout. However, it is still required to ensure the URL will render correctly once the issue is resolved.

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

If the getStartedMessages property isn't used, the callout is populated with the name.short and description.short values.