| Service | Microsoft Docs article | Related commit history on GitHub | Change details |
|---|---|---|---|
| platform | How Conversation Ai Get Started | https://github.com/MicrosoftDocs/msteams-docs/commits/main/msteams-platform/bots/how-to/teams-conversational-ai/how-conversation-ai-get-started.md | Create a folder called prompts and define your prompts in the folder. When the u * `config.json`: Contains the prompt model settings. Provide the right configuration to ensure bot responses are aligned with your requirement. - [Sample code reference](https://github.com/microsoft/teams-ai/blob/main/js/samples/03.ai-concepts/c.actionMapping-lightBot/src/prompts/sequence/config.json) + [Sample code reference](https://github.com/microsoft/teams-ai/blob/main/js/samples/03.ai-concepts/c.actionMapping-lightBot/src/prompts/tools/config.json) ```json { |
| platform | Manifest Schema Dev Preview | https://github.com/MicrosoftDocs/msteams-docs/commits/main/msteams-platform/resources/schema/manifest-schema-dev-preview.md | The schema defines the following properties: ## $schema -*Optional, but recommended* – String +**Optional** (but recommended) – String -The `https://` URL referencing the JSON Schema for the app manifest. +The *https://* URL referencing the JSON Schema for the app manifest. ## manifestVersion Specifies information about the developer and their business. For Teams Store ap | Name | Type | Maximum size | Required | Description | |--|--||-|-| | `name` | String | 32 characters | Γ£ö∩╕Å | The display name for the developer. |-| `websiteUrl` | | 2048 characters | Γ£ö∩╕Å | The `https://` URL to the app-specific page on your website. | -| `privacyUrl` | | 2048 characters | Γ£ö∩╕Å | The `https://` URL to the app's privacy policy. | -| `termsOfUseUrl` | | 2048 characters | Γ£ö∩╕Å | The `https://` URL to the app's terms of use. | +| `websiteUrl` | String | 2048 characters | Γ£ö∩╕Å | The *https://* URL to the app-specific page on your website. | +| `privacyUrl` | String | 2048 characters | Γ£ö∩╕Å | The *https://* URL to the app's privacy policy. | +| `termsOfUseUrl` | String | 2048 characters | Γ£ö∩╕Å | The *https://* URL to the app's terms of use. | | `mpnId` | String | 10 characters | | The Microsoft Cloud Partner Program (CCP) ID (formerly known as Microsoft Partner Network (MPN) ID) that identifies the partner organization creating the app. **Optional** | | `contactInfo` | Object | | | App developer's contact information. | Describes your app to users. For apps submitted to AppSource, these values must Ensure that your description accurately describes your experience and provides information to help potential customers understand what your experience does. You must note in the full description, if an external account is required for use. The values of `short` and `full` must be different. Your short description must not be repeated within the long description and must not include any other app name. -|Name| Maximum size | Required | Description| -||||| -|`short`|80 characters|Γ£ö∩╕Å|A short description of your app experience, used when space is limited.| -|`full`|4000 characters|Γ£ö∩╕Å|The full description of your app.| +|Name| Type | Maximum size | Required | Description| +|||||| +|`short`| String |80 characters|Γ£ö∩╕Å|A short description of your app experience, used when space is limited.| +|`full`| String |4000 characters|Γ£ö∩╕Å|The full description of your app.| ## icons The object is an array with all elements of the type `object`. This block is req |Name| Type| Maximum size | Required | Description| ||||||-|`configurationUrl`|String|2048 characters|Γ£ö∩╕Å|The https:// URL to use when configuring the tab.| +|`configurationUrl`|String|2048 characters|Γ£ö∩╕Å|The *https://* URL to use when configuring the tab.| |`canUpdateConfiguration`|Boolean|||A value indicating whether an instance of the tab's configuration can be updated by the user after creation. <br>Default value: `true`| |`scopes`|Array of enum|2|Γ£ö∩╕Å|Configurable tabs only support the `team` and `groupChat` scopes. | |`context` |Array of enum|8||The set of `contextItem` scopes where a [tab is supported](../../tabs/how-to/access-teams-context.md). <br>Default values: `channelTab`, `privateChatTab`, `meetingChatTab`, `meetingDetailsTab`, `meetingSidePanel`, `meetingStage`, `personalTab`.| The object is an array (maximum of 16 elements) with all elements of the type `o |Name| Type| Maximum size | Required | Description| |||||| |`entityId`|String|64 characters|Γ£ö∩╕Å|A unique identifier for the entity that the tab displays.|-|`name`|String|128 characters|Γ£ö∩╕Å|The display name of the tab.| -|`contentUrl`|String|2048 characters|Γ£ö∩╕Å|The https:// URL that points to the entity UI to be displayed in the Teams canvas.| +|`name`|String|128 characters||The display name of the tab.| +|`contentUrl`|String|2048 characters||The *https://* URL that points to the entity UI to be displayed in the Teams canvas.| |`contentBotId`|String| | | The Microsoft Teams app ID specified for the bot in the Bot Framework portal. |-|`websiteUrl`|String|2048 characters||The https:// URL to point at if a user opts to view in a browser.| +|`websiteUrl`|String|2048 characters||The *https://* URL to point at if a user opts to view in a browser.| |`scopes`|Array of enum|3|Γ£ö∩╕Å|Static tabs support the `personal`, `team`, and `groupChat` scopes, which means it can be provisioned as part of the personal, group chat, and channel meetings experience.|-|`searchUrl`|String|2048 characters||The https:// URL to direct a user's search queries.| +|`searchUrl`|String|2048 characters||The *https://* URL to direct a user's search queries.| |`context`|Array of enum|8||The set of `contextItem` scopes to which a tab belongs. <br>Default values: `personalTab`, `channelTab`, `privateChatTab`, `meetingChatTab`, `meetingDetailsTab`, `meetingSidePanel`, `meetingStage`, `teamLevelApp`| |`supportedPlatform`|Array of enum|3||The set of `supportedPlatform` scopes to which a tab belongs. <br>Default values: `desktop`, `mobile`, `teamsMeetingDevices`| The object is an array (maximum of only 1 element— only one bot is allowed ### bots.configuration +**Optional** – Object + |Name| Type| Maximum size | Required | Description| |||||| |`team.fetchTask`|Boolean||Γ£ö∩╕Å|A boolean value that indicates if it should fetch dialog (referred as task module in TeamsJS v1.x) dynamically. <br>Default value: `false`|+|`team.taskInfo`|Object||Γ£ö∩╕Å|The dialog to preload when you use a bot.| |`team.taskInfo.title`|String|64 characters|Γ£ö∩╕Å|Initial dialog title.|-|`team.taskInfo.width`|String|16||The dialog width is either a number in pixels or default layout such as `large`, `medium`, or `small`.| -|`team.taskInfo.height`|String|16||The dialog height is either a number in pixels or default layout such as `large`, `medium`, or `small`.| +|`team.taskInfo.width`|String|16 characters||The dialog width is either a number in pixels or default layout such as `large`, `medium`, or `small`.| +|`team.taskInfo.height`|String|16 characters||The dialog height is either a number in pixels or default layout such as `large`, `medium`, or `small`.| |`team.taskInfo.url`|String|2048 characters||Initial webview URL.| |`groupChat.fetchTask`|Boolean||Γ£ö∩╕Å|A boolean value that indicates if it should fetch dialog dynamically. <br>Default value: `false`| |`groupChat.taskInfo`|Object|||Dialog to be launched when fetch task set to false.<br>Default value: `false`| |`groupChat.taskInfo.title`|String|64 characters|Γ£ö∩╕Å|Initial dialog title.|-|`groupChat.taskInfo.width`|String|16||The dialog width is either a number in pixels or default layout such as `large`, `medium`, or `small`.| -|`groupChat.taskInfo.height`|String|16||The dialog height is either a number in pixels or default layout such as `large`, `medium`, or `small`.| +|`groupChat.taskInfo.width`|String|16 characters||The dialog width is either a number in pixels or default layout such as `large`, `medium`, or `small`.| +|`groupChat.taskInfo.height`|String|16 characters||The dialog height is either a number in pixels or default layout such as `large`, `medium`, or `small`.| |`groupChat.taskInfo.url`|String|2048 characters||Initial webview URL.| ### bots.commandLists -An optional list of commands that your bot can recommend to users. The object is an array (maximum of 2 elements) with all elements of type `object`; you must define a separate command list for each scope that your bot supports. For more information, see [Bot menus](~/bots/how-to/create-a-bot-commands-menu.md). +**Optional** – Array ++An optional list of commands that your bot can recommend to users. The object is an array (maximum of 3 elements) with all elements of type `object`; you must define a separate command list for each scope that your bot supports. For more information, see [Bot menus](~/bots/how-to/create-a-bot-commands-menu.md). ++|Name| Type| Maximum size | Required | Description| +|||||| +|`scopes`|Array of enum|3|Γ£ö∩╕Å|Specifies the scope for which the command list is valid. Options are `team`, `personal`, and `groupChat`.| +|`commands`|Array of objects|10|Γ£ö∩╕Å|An array of commands the bot supports.| ++### bots.commandLists.commands ++**Required** – Array |Name| Type| Maximum size | Required | Description| ||||||-|`items.scopes`|Array of enum|3|Γ£ö∩╕Å|Specifies the scope for which the command list is valid. Options are `team`, `personal`, and `groupChat`.| -|`items.commands`|Array of objects|10|Γ£ö∩╕Å|An array of commands the bot supports:<br>`title`: the bot command name (string, 32).<br>`description`: a simple description or example of the command syntax and its argument (string, 128).| +|`title`|String|32 characters|Γ£ö∩╕Å|The bot command name.| +|`description`|String|128 characters|Γ£ö∩╕Å|A simple text description or an example of the command syntax and its arguments.| ## connectors The object is an array (maximum of 1 element) with all elements of type `object` |Name| Type| Maximum size | Required | Description| ||||||-|`configurationUrl`|String|2048 characters|Γ£ö∩╕Å|The https:// URL to use when configuring the connector using the inline configuration experience.| +|`configurationUrl`|String|2048 characters||The *https://* URL to use when configuring the connector using the inline configuration experience.| |`connectorId`|String|64 characters|Γ£ö∩╕Å|A unique identifier for the Connector that matches its ID in the [Connectors Developer Dashboard](https://aka.ms/connectorsdashboard).| |`scopes`|Array of enum|1|Γ£ö∩╕Å|Specifies whether the Connector offers an experience in the context of a channel in a `team`, or an experience scoped to an individual user alone (`personal`). The `team` scope is only supported.| The object is an array (maximum of 1 element) with all elements of type `object` |||||| |`botId`|String|||The unique Microsoft app ID for the bot that backs the message extension, as registered with the Bot Framework. The ID can be the same as the overall [app ID](#id).| |`composeExtensionType`|String|||Type of the compose extension. Enum values are `botBased` and `apiBased`.|-|`authorization`|Object|2||Authorization related information for the API-based message extension| +|`authorization`|Object|2||Authorization related information for the API-based message extension.| |`authorization.authType`|String|||Enum of possible authorization types. Supported values are `none`, `apiSecretServiceAuth`, and `microsoftEntra`.| |`authorization.microsoftEntraConfiguration`|Object|||Object capturing details needed to do microsoftEntra auth flow. Applicable only when auth type is `microsoftEntra`.|-|`authorization.microsoftEntraConfiguration.supportsSingleSignOn`|boolean|||A value indicating whether single sign-on is configured for the app.| +|`authorization.microsoftEntraConfiguration.supportsSingleSignOn`|Boolean|||A value indicating whether single sign-on is configured for the app.| |`authorization.apiSecretServiceAuthConfiguration`|Object|||Object capturing details needed to do service auth. Applicable only when auth type is `apiSecretServiceAuth`.| |`authorization.apiSecretServiceAuthConfiguration.apiSecretRegistrationId`|String|128 characters||Registration ID returned when developer submits the API key through Developer Portal.| |`apiSpecificationFile`|String|2048 characters||A relative file path to the api specification file in the manifest package.| |`canUpdateConfiguration`|Boolean|||A value indicating whether the configuration of a message extension can be updated by the user. <br>Default value: `true`|-|`commands`|Array of object|10||Array of commands the message extension supports.| +|`commands`|Array of objects|10||Array of commands the message extension supports.| |`messageHandlers`|Array of objects|5||A list of handlers that allow apps to be invoked when certain conditions are met. Domains must also be listed in `validDomains`.|-|`messageHandlers.type`|String|||The type of message handler. Must be `"link"`.| +|`messageHandlers.type`|String|||The type of message handler. Must be `link`.| |`messageHandlers.value.domains`|Array of Strings|2048 characters||Array of domains that the link message handler can register for.|-|`messageHandlers.supportsAnonymizedPayloads`|Boolean|||A Boolean value that indicates whether the app's link message handler supports anonymous invoke flow. <br>Default value: `false` <br> To enable zero install for link unfurling, the value needs to be set to `true`. <br/> **Note**: The property `supportAnonymousAccess` is superseded by `supportsAnonymizedPayloads`.| -|`type` | Type of the compose extension. Supported values are `apiBased` or `botBased`. | +|`messageHandlers.supportsAnonymizedPayloads`|Boolean|||A boolean value that indicates whether the app's link message handler supports anonymous invoke flow. <br>Default value: `false` <br> To enable zero install for link unfurling, the value needs to be set to `true`. <br/> **Note**: The property `supportAnonymousAccess` is superseded by `supportsAnonymizedPayloads`.| +|`type` | Type of the compose extension. Supported values are `apiBased` or `botBased`. | ### composeExtensions.commands Each command item is an object with the following structure: |||||| |`id`|String|64 characters|Γ£ö∩╕Å|The ID for the command.| |`type`|String|64 characters||Type of the command. One of `query` or `action`. Default: `query`|-|`samplePrompts`|array|5 |No|Property used by Copilot to display prompts supported by the plugin to the user. For Copilot scenarios, this property is required in order to pass app validation for store submission. | +|`samplePrompts`|Array|5 ||Property used by Copilot to display prompts supported by the plugin to the user. For Copilot scenarios, this property is required in order to pass app validation for store submission. | |`samplePrompts.text`|string|128 characters|Γ£ö∩╕Å|Content of the sample prompt.| |`apiResponseRenderingTemplateFile`|String|2048 characters||A relative file path for api [response rendering template](https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.ResponseRenderingTemplate.schema.json) file used to format the JSON response from developerΓÇÖs API to Adaptive Card response.| |`context`|Array of Strings|3 characters||Defines where the message extension can be invoked from. Any combination of `compose`, `commandBox`, `message`. <br>Default values: `compose, commandBox`| Each command item is an object with the following structure: |`description`|String|128 characters||The description that appears to users to indicate the purpose of this command.| |`semanticDescription`|String|5000 characters||Semantic description of the command for consumption by Copilot using Large Language Models (LLMs).| |`initialRun`|Boolean|||A Boolean value that indicates whether the command runs initially with no parameters. <br>Default value: `false`|-|`fetchTask`|Boolean|||A Boolean value that indicates if it must fetch the dialog dynamically.| +|`fetchTask`|Boolean|||A Boolean value that indicates if it must fetch the dialog dynamically.<br>Default value: `false`| |`taskInfo`|Object|||Specify the dialog to preload when using a message extension command.| |`taskInfo.title`|String|64 characters||Initial dialog title.|-|`taskInfo.width`|String|||Dialog width - either a number in pixels or default layout such as `large`, `medium`, or `small`.| -|`taskInfo.height`|String|||Dialog height - either a number in pixels or default layout such as `large`, `medium`, or `small`.| +|`taskInfo.width`|String|16 characters||Dialog width - either a number in pixels or default layout such as `large`, `medium`, or `small`.| +|`taskInfo.height`|String|16 characters||Dialog height - either a number in pixels or default layout such as `large`, `medium`, or `small`.| |`taskInfo.url`|String|2048 characters||Initial webview URL.|-|`parameters`|Array of object|5||The list of parameters the command takes. Minimum: 1; maximum: 5| -|`parameter.name`|String|64 characters|Γ£ö∩╕Å|The name of the parameter as it appears in the client. This is included in the user request. </br> For Api-based message extension, The name must map to the `parameters.name` in the OpenAPI Description. If you're referencing a property in the request body schema, then the name must map to `properties.name` or query parameters. | -|`parameter.title`|String|32 characters|Γ£ö∩╕Å|User-friendly title for the parameter.| -|`parameter.description`|String|128 characters||User-friendly string that describes this parameterΓÇÖs purpose.| -|`parameter.semanticDescription`|String|2000 characters||Semantic description of the parameter for consumption by the Large Language Models (LLMs).| -|`parameter.inputType`|String|||Defines the type of control displayed on a dialog for `fetchTask: false`. One of `text`, `textarea`, `number`, `date`, `time`, `toggle`, `choiceset`.| -|`parameter.value`|String|512 characters||Initial value for the parameter.| -|`parameter.choices`|Array of objects|10||The choice options for the `choiceset`. Use only when `parameter.inputType` is `choiceset`.| -|`parameter.choices.title`|String|128 characters|Γ£ö∩╕Å|Title of the choice.| -|`parameter.choices.value`|String|512 characters|Γ£ö∩╕Å|Value of the choice.| +|`parameters`|Array of objects|5||The list of parameters the command takes.| +|`parameters.name`|String|64 characters|Γ£ö∩╕Å|The name of the parameter as it appears in the client. This is included in the user request. </br> For Api-based message extension, The name must map to the `parameters.name` in the OpenAPI Description. If you're referencing a property in the request body schema, then the name must map to `properties.name` or query parameters. | +|`parameters.title`|String|32 characters|Γ£ö∩╕Å|User-friendly title for the parameter.| +|`parameters.description`|String|128 characters||User-friendly string that describes this parameterΓÇÖs purpose.| +|`parameters.semanticDescription`|String|2000 characters||Semantic description of the parameter for consumption by the Large Language Models (LLMs).| +|`parameters.inputType`|String|||Defines the type of control displayed on a dialog for `fetchTask: false`. Input value can only be one of `text`, `textarea`, `number`, `date`, `time`, `toggle`, `choiceset`. <br>Default value: `text`| +|`parameters.value`|String|512 characters||Initial value for the parameter.| +|`parameters.choices`|Array of objects|10||The choice options for the `choiceset`. Use only when `parameters.inputType` is `choiceset`.| +|`parameters.choices.title`|String|128 characters|Γ£ö∩╕Å|Title of the choice.| +|`parameters.choices.value`|String|512 characters|Γ£ö∩╕Å|Value of the choice.| ## scopeConstraints Specify the app's Graph connector configuration. If this is present, then [webAp |Name| Type| Maximum size | Required | Description| ||||||-|`notificationUrl`|string|2048 characters|Γ£ö∩╕Å|The https:// URL where Graph-connector notifications for the application must be sent.| +|`notificationUrl`|String|2048 characters|Γ£ö∩╕Å|The *https://* URL where Graph-connector notifications for the application must be sent.| ## showLoadingIndicator Define the properties your app uses to post a user activity feed. |Name| Type| Maximum size | Required | Description| ||||||-|`activityTypes`|Array of objects|128 items| | Provide the types of activities that your app can post to a users activity feed. The `systemDefault` activity type is a reserved and invalid string.| +|`activityTypes`|Array of objects| 128 | | Provide the types of activities that your app can post to a users activity feed. The `systemDefault` activity type is a reserved and invalid string.| ### activities.activityTypes |Name| Type| Maximum size | Required | Description| ||||||-|`type`|String|32 characters|Γ£ö∩╕Å|The notification type. *See below*.| -|`description`|String|128 characters|Γ£ö∩╕Å|A brief description of the notification. *See below*.| +|`type`|String|32 characters|Γ£ö∩╕Å|The notification type.| +|`description`|String|128 characters|Γ£ö∩╕Å|A brief description of the notification.| |`templateText`|String|128 characters|Γ£ö∩╕Å|Ex: "{actor} created task {taskId} for you"| ```json A value that indicates whether an app is blocked by default until admin allows i **Optional** – String -The https:// URL to the page that provides additional app information for the admins. The maximum length of the string is 2048 characters. +The *https://* URL to the page that provides additional app information for the admins. The maximum length of the string is 2048 characters. ## defaultInstallScope Specifies the SaaS offer associated with your app. |Name| Type| Maximum size | Required | Description| ||||||-|`offerId`| string | 2,048 characters | Γ£ö∩╕Å | A unique identifier that includes your Publisher ID and Offer ID, which you can find in [Partner Center](https://partner.microsoft.com/dashboard). You must format the string as `publisherId.offerId`.| +|`offerId`| String | 2048 characters | Γ£ö∩╕Å | A unique identifier that includes your Publisher ID and Offer ID, which you can find in [Partner Center](https://partner.microsoft.com/dashboard). You must format the string as `publisherId.offerId`.| ## meetingExtensionDefinition Specify meeting extension definition. For more information, see [custom Together |Name| Type| Maximum size | Required | Description| ||||||-|`scenes`|Array of objects| 5 items||Meeting supported scenes.| +|`scenes`|Array of objects| 5 ||Meeting supported scenes.| |`supportsStreaming`|Boolean|||A Boolean value that indicates whether an app can stream the meeting's audio and video content to a real-time meeting protocol (RTMP) endpoint. <br>Default value: `false`|-|`videoFiltersConfigurationUrl`|String|2048 characters||The https:// URL for configuring the video filters.| +|`videoFiltersConfigurationUrl`|String|2048 characters||The *https://* URL for configuring the video filters.| |`supportsAnonymousGuestUsers`|Boolean|||A Boolean value that indicates whether the app supports access by anonymous guest users. <br>Default value: `false`| ### meetingExtensionDefinition.scenes Specify and consolidate authorization related information for the app. |Name| Type|Maximum size|Required |Description| ||||||-|`resourceSpecific`| Array of objects|16 items||Permissions that guard data access on resource instance level.| +|`resourceSpecific`| Array of objects|16 ||Permissions that guard data access on resource instance level.| ### authorization.permissions.resourceSpecific The `extensions` property specifies Outlook Add-ins within an app manifest and s |Name| Type| Maximum size | Required | Description| |||||| |`requirements`| Object | | | Specifies the set of client or host requirements for the extension. |-|`runtimes`| Array | | | Configures the set of runtimes and actions that can be used by each extension point. For more information, see [runtimes in Office Add-ins](/office/dev/add-ins/testing/runtimes). | -|`ribbons`| Array | | | Defines the ribbons extension point. | -|`autoRunEvents`| Array | | | Defines the event-based activation extension point. | -|`alternates`| Array | | | Specifies the relationship to alternate existing Microsoft 365 solutions. It's used to hide or prioritize add-ins from the same publisher with overlapping functionality. | +|`runtimes`| Array | 20 | | Configures the set of runtimes and actions that can be used by each extension point. For more information, see [runtimes in Office Add-ins](/office/dev/add-ins/testing/runtimes). | +|`ribbons`| Array | 20 | | Defines the ribbons extension point. | +|`autoRunEvents`| Array | 10 | | Defines the event-based activation extension point. | +|`alternates`| Array | 10 | | Specifies the relationship to alternate existing Microsoft 365 solutions. It's used to hide or prioritize add-ins from the same publisher with overlapping functionality. | |`audienceClaimUrl`| String | 2048 characters | | Specifies the URL for your extension and is used to validate Exchange user identity tokens. For more information, see [inside the Exchange identity token](/office/dev/add-ins/outlook/inside-the-identity-token)| For more information, see [Office Add-ins manifest for Microsoft 365](/office/dev/add-ins/develop/unified-manifest-overview). The `extensions.requirements` object specifies the scopes, form factors, and Off |Name| Type| Maximum size | Required | Description| ||||||-|`requirements.capabilities`| Array | | | Identifies the requirement sets. <br>Options: `name` (required), `minVersion`, `maxVersion`| -|`requirements.capabilities.name`| String | | Γ£ö∩╕Å | Identifies the name of the requirement set. | -|`requirements.capabilities.minVersion`| String | | | Identifies the minimum version for the requirement set. | -|`requirements.capabilities.maxVersion`| String | | | Identifies the maximum version for the requirement set. | -|`requirements.scopes`| Array of enums | 1 | | Identifies the scopes in which the add-in can run and defines the Microsoft 365 applications in which the extension can run. For example, `mail` (Outlook). <br>Supported value: `mail` | -|`requirements.formFactors`| Array of enums | | | Identifies the form factors that support the add-in. <br>Supported values: `mobile`, `desktop`| +|`capabilities`| Array | 100 | | Identifies the requirement sets.| +|`capabilities.name`| String | | Γ£ö∩╕Å | Identifies the name of the requirement set. | +|`capabilities.minVersion`| String | | | Identifies the minimum version for the requirement set. | +|`capabilities.maxVersion`| String | | | Identifies the maximum version for the requirement set. | +|`scopes`| Array of enums | 1 | | Identifies the scopes in which the add-in can run and defines the Microsoft 365 applications in which the extension can run. For example, `mail` (Outlook). <br>Supported value: `mail` | +|`formFactors`| Array of enums | | | Identifies the form factors that support the add-in. <br>Supported values: `mobile`, `desktop`| ### extensions.runtimes +**Optional** – Array + The `extensions.runtimes` array configures the sets of runtimes and actions that each extension point can use. |Name| Type| Maximum size | Required | Description| The `extensions.runtimes` array configures the sets of runtimes and actions that |`id`| String | 64 characters | Γ£ö∩╕Å | Specifies the ID for runtime. | |`type`| String enum | | Γ£ö∩╕Å | Specifies the type of runtime. The supported enum value for [browser-based runtime](/office/dev/add-ins/testing/runtimes#browser-runtime) is `general`. | |`code`| 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. |-|`code.page`| URL | | Γ£ö∩╕Å | 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](/office/dev/add-ins/testing/runtimes#browser-runtime)). | -|`code.script`| URL | | | Specifies the URL of the JavaScript file to be loaded in [JavaScript-only runtime](/office/dev/add-ins/testing/runtimes#javascript-only-runtime). | -|`lifetime`| String enum | | | Specifies the lifetime of the runtime. Runtimes with a `short` lifetime donΓÇÖt preserve state across executions while runtimes with a `long` lifetime do. For more information, see [Runtimes in Office Add-ins](/office/dev/add-ins/testing/runtimes).| -|`actions`| Array | | | Specifies the set of actions supported by the runtime. An action is either running a JavaScript function or opening a view such as a task pane.| +|`code.page`| String | 2048 characters | Γ£ö∩╕Å | 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](/office/dev/add-ins/testing/runtimes#browser-runtime)). | +|`code.script`| String | 2048 characters | | Specifies the URL of the JavaScript file to be loaded in [JavaScript-only runtime](/office/dev/add-ins/testing/runtimes#javascript-only-runtime). | +|`lifetime`| String enum | | | Specifies the lifetime of the runtime. Runtimes with a `short` lifetime donΓÇÖt preserve state across executions while runtimes with a `long` lifetime do. For more information, see [Runtimes in Office Add-ins](/office/dev/add-ins/testing/runtimes).<br>Default value: `short`| +|`actions`| Array | 20 | | Specifies the set of actions supported by the runtime. An action is either running a JavaScript function or opening a view such as a task pane.| |`actions.id`| String | 64 characters | Γ£ö∩╕Å | Specifies the ID for the action, which is passed to the code file. | |`actions.type`| String | | Γ£ö∩╕Å | Specifies the type of action. The `executeFunction` type runs a JavaScript function without waiting for it to finish and the `openPage` type opens a page in a given view. | |`actions.displayName`| String | 64 characters | | Specifies the display name of the action and it isn't the label of a button or a menu item that invokes the action (which is configured with `tabs.groups.controls.label`).| |`actions.pinnable`| Boolean | | | Specifies that a task pane supports pinning, which keeps the task pane open when the user changes the selection. <br>Default value: `false`| |`actions.view`| String | 64 characters | | Specifies the view where the page must be opened. It's used only when `actions.type` is `openPage`. |-|`actions.multiselect`| Boolean | | | Specifies whether the end user can select multiple items, such as multiple email messages, and apply the action to all of them.| -|`actions.supportsNoItemContext`| Boolean | | | Allows task pane add-ins to activate without the Reading Pane enabled or a message selected. | +|`actions.multiselect`| Boolean | | | Specifies whether the end user can select multiple items, such as multiple email messages, and apply the action to all of them.<br>Default value: `false`| +|`actions.supportsNoItemContext`| Boolean | | | Allows task pane add-ins to activate without the Reading Pane enabled or a message selected.<br>Default value: `false`| |`requirements`| Object | | | Specifies the scopes, formFactors, and Office JavaScript Library requirement sets that must be supported on the Office client in order for the runtime to be included in the add-in. For more information, see [Specify Office Add-in requirements in the unified manifest for Microsoft 365](/office/dev/add-ins/develop/requirements-property-unified-manifest).| |`requirements.capabilities`| Array | | | Identifies the requirement sets. <br>Options: `name` (required), `minVersion`, `maxVersion`| |`requirements.capabilities.name`| String | | Γ£ö∩╕Å | Identifies the name of the requirement set. | To use `extensions.runtimes`, see [create add-in commands](/office/dev/add-ins/d ### extensions.ribbons +**Optional** – Array + The `extensions.ribbons` property provides the ability to add [add-in commands](/office/dev/add-ins/design/add-in-commands) (buttons and menu items) to the Microsoft 365 application's ribbon. The ribbon definition is selected from the array based on the requirements and first-of order. |Name| Type| Maximum size | Required | Description| The `extensions.ribbons` property provides the ability to add [add-in commands]( |`requirements.capabilities.maxVersion`| String | | | Identifies the maximum version for the requirement set. | |`requirements.scopes`| Array of enums | 1 | | Identifies the scopes in which the add-in can run and defines the Microsoft 365 applications in which the extension can run. For example, `mail` (Outlook). <br>Supported value: `mail` | |`requirements.formFactors`| Array of enums | | | Identifies the form factors that support the add-in. <br>Supported values: `mobile`, `desktop`|-|`tabs`| Array | |Γ£ö∩╕Å| Configures the custom tabs on the Microsoft 365 application ribbon. | +|`tabs`| Array | 20 |Γ£ö∩╕Å| Configures the custom tabs on the Microsoft 365 application ribbon. | |`tabs.id`| String | 64 characters | | Specifies the ID for the tab within the app.| |`tabs.builtinTabId`| String | 64 characters | | Specifies the ID of a built-in Office ribbon tab. For more information on possible values, see [find the IDs of built-in Office ribbon tabs](/office/dev/add-ins/develop/built-in-ui-ids).| |`tabs.label`| String | 64 characters | | Specifies the text displayed for the tab. Despite the maximum length of 64 characters, to correctly align the tab in the ribbon, we recommend you limit the label to 16 characters.| |`tabs.position`| Object | | | Configures the position of the custom tab relative to other tabs on the ribbon.| |`tabs.position.builtinTabId`| String | 64 characters | Γ£ö∩╕Å | Specifies the ID of the built-in tab that the custom tab should be positioned next to. For more information, see [find the IDs of controls and control groups](/office/dev/add-ins/design/built-in-button-integration#find-the-ids-of-controls-and-control-groups).| |`tabs.position.align`| String enum | | Γ£ö∩╕Å | Defines the alignment of custom tab relative to the specified built-in tab. <br>Supported values: `after`, `before`|-|`tabs.groups`| Array | | | Defines groups of controls on a ribbon tab on a non-mobile device. For mobile devices, see `tabs.customMobileRibbonGroups` below.| +|`tabs.groups`| Array | 10 | | Defines groups of controls on a ribbon tab on a non-mobile device. For mobile devices, see `tabs.customMobileRibbonGroups` below.| |`tabs.groups.id`| String |64 characters | | Specifies the ID for the tab group within the app. It must be different from any built-in group ID in the Microsoft 365 application and any other custom group.| |`tabs.groups.label`| String | 64 characters | | Specifies the text displayed for the group. Despite the maximum length of 64 characters, to correctly align the tab in the ribbon, we recommend you limit the label to 16 characters.|-|`tabs.groups.icons`| Array | | | Specifies the icons displayed for the group. | +|`tabs.groups.icons`| Array | 3 | | Specifies the icons displayed for the group. | |`tabs.groups.icons.size`| Number | |Γ£ö∩╕Å| Specifies the size of the icon in pixels, enumerated as `16`,`20`,`24`,`32`,`40`,`48`,`64`,`80`. <br>Required image sizes: `16`, `32`, `80`. |-|`tabs.groups.icons.url`| URL| | Γ£ö∩╕Å | Specifies the absolute URL of the icon.| +|`tabs.groups.icons.url`| String | 2048 characters | Γ£ö∩╕Å | Specifies the absolute URL of the icon.| |`tabs.groups.controls`| Array | | | Configures the buttons and menus in the group. | |`tabs.groups.controls.id`| String | 64 characters| Γ£ö∩╕Å | Specifies the ID for the control within the app. It must be different from any built-in control ID in the Microsoft 365 application and any other custom control. | |`tabs.groups.controls.items`| Array | | | Configures the items for a menu control. | The `extensions.ribbons` property provides the ability to add [add-in commands]( |`tabs.groups.controls.items.label`| String | 64 characters| Γ£ö∩╕Å | Specifies the text displayed for the items. | |`tabs.groups.controls.items.icons`| Array | | | Configures the icons for the custom item.| |`tabs.groups.controls.items.icons.size`| Number | |Γ£ö∩╕Å| Specifies the size of the icon in pixels, enumerated as `16`,`20`,`24`,`32`,`40`,`48`,`64`,`80`. <br>Required image sizes: `16`, `32`, `80`. |-|`tabs.groups.controls.items.icons.url`| URL| | Γ£ö∩╕Å | Specifies the absolute URL of the icon.| +|`tabs.groups.controls.items.icons.url`| String | 2048 characters | Γ£ö∩╕Å | Specifies the absolute URL of the icon.| |`tabs.groups.controls.items.supertip`| | |Γ£ö∩╕Å| Configures a supertip for the custom item. A supertip is a UI feature that displays a brief box of help information about a control when the cursor hovers over it. The box may contain multiple lines of text. | |`tabs.groups.controls.items.supertip.title`| String | 64 characters | Γ£ö∩╕Å | Specifies the title text of the supertip.|-|`tabs.groups.controls.items.supertip.description`| String | 128 characters | Γ£ö∩╕Å | Specifies the description of the supertip.| -|`tabs.groups.controls.items.actionId`| String | 64 characters | | Specifies the ID of the action that is taken when a user selects the control or menu item. The `actionId` must match with `runtime.actions.id`. | +|`tabs.groups.controls.items.supertip.description`| String | 250 characters | Γ£ö∩╕Å | Specifies the description of the supertip.| +|`tabs.groups.controls.items.actionId`| String | 64 characters | Γ£ö∩╕Å | Specifies the ID of the action that is taken when a user selects the control or menu item. The `actionId` must match with `runtime.actions.id`. | |`tabs.groups.controls.items.enabled`| Boolean | | | Indicates whether the control is initially enabled. <br>Default value: `true`| |`tabs.groups.controls.items.overriddenByRibbonApi`| Boolean | | | Specifies whether a group, button, menu, or menu item hidden on application and platform combinations, which support the API ([Office.ribbon.requestCreateControls](/javascript/api/office/office.ribbon#office-office-ribbon-requestcreatecontrols-member(1))) that installs custom contextual tabs on the ribbon. <br>Default value: `false`| |`tabs.groups.controls.type`| String | | Γ£ö∩╕Å | Defines the control type. <br>Supported values: `button`, `menu`| The `extensions.ribbons` property provides the ability to add [add-in commands]( |`tabs.groups.controls.label`| String | 64 characters | Γ£ö∩╕Å | Specifies the text displayed for the control. Despite the maximum length of 64 characters, to correctly align the tab in the ribbon, we recommend you limit the label to 16 characters.| |`tabs.groups.controls.icons`| Array | | Γ£ö∩╕Å | Defines the icons for the control. There must be at least three child objects; one each with `size` properties of `16`, `32`, and `80` pixels. | |`tabs.groups.controls.icons.size`| Number | | Γ£ö∩╕Å | Specifies the size of the icon in pixels, enumerated as `16`,`20`,`24`,`32`,`40`,`48`,`64`,`80`. <br> Required image size: `16`, `32`, `80`|-|`tabs.groups.controls.icons.url`| URL| | | Specifies the absolute URL to the icon.| +|`tabs.groups.controls.icons.url`| String | 2048 characters | | Specifies the absolute URL to the icon.| |`tabs.groups.controls.supertip`| Object | | Γ£ö∩╕Å | Configures a supertip for the control. | |`tabs.groups.controls.supertip.title`| String | 64 characters | Γ£ö∩╕Å |Specifies the title text of the supertip.| |`tabs.groups.controls.supertip.description`| String | 128 characters | Γ£ö∩╕Å | Specifies the description of the supertip.| The `extensions.ribbons` property provides the ability to add [add-in commands]( |`tabs.customMobileRibbonGroups.id` | String | 250 characters | Γ£ö∩╕Å | Specifies the ID of the group. It must be different from any built-in group ID in the Microsoft 365 application and any other custom group.| |`tabs.customMobileRibbonGroups.label` | String | 32 characters | Γ£ö∩╕Å | Specifies the label on the group. | |`tabs.customMobileRibbonGroups.controls` | Array | 20 | Γ£ö∩╕Å | Defines the controls in the group. Only mobile buttons are supported.|-|`tabs.customMobileRibbonGroups.controls.id` | String | 250 characters | Γ£ö∩╕Å | Specifies the ID of the control such as "msgReadFunctionButton".| -|`tabs.customMobileRibbonGroups.controls.type` | String enum | | Γ£ö∩╕Å | Specifies the type of control. "MobileButton" is only supported.| +|`tabs.customMobileRibbonGroups.controls.id` | String | 250 characters | Γ£ö∩╕Å | Specifies the ID of the control such as `msgReadFunctionButton`.| +|`tabs.customMobileRibbonGroups.controls.type` | String enum | | Γ£ö∩╕Å | Specifies the type of control. `MobileButton` is only supported.| |`tabs.customMobileRibbonGroups.controls.label` | String | 32 characters | Γ£ö∩╕Å | Specifies the label on the control.| |`tabs.customMobileRibbonGroups.controls.actionId` | String | 64 characters | Γ£ö∩╕Å | Specifies the ID of the action that is taken when a user selects the control. The `actionId` must match the `runtime.actions.id` property of an action in the `runtimes` object.| |`tabs.customMobileRibbonGroups.controls.icons` | Array | 9 | Γ£ö∩╕Å | Specifies the icons that will appear on the control depending on the dimensions and DPI of the mobile device screen. There must be exactly 9 icons.| To use `extensions.ribbons`, see [create add-in commands](/office/dev/add-ins/de ### extensions.autoRunEvents +**Optional** – Array + The `extensions.autoRunEvents` property defines event-based activation extension points. |Name| Type| Maximum size | Required | Description| The `extensions.alternates` property is used to hide or prioritize specific in-m |`requirements.formFactors`| Array of enums | | | Identifies the form factors that support the add-in. <br>Supported values: `mobile`, `desktop`| |`alternateIcons`| Object | | | Specifies the main icons that are used to represent the add-in on older versions of Office. This property is **required** if the Office add-in is to be installable in Office on Mac, perpetual Office licenses, and Microsoft 365 subscription versions of Office on Windows earlier than 2304 (Build 16320.00000).| |`alternateIcons.icon`| Object | | Γ£ö∩╕Å | Specifies properties of the image file used to represent the add-in. |-|`alternateIcons.icon.size`| Number enum | | Γ£ö∩╕Å | This property is reserved for future use. The value must be 64.| +|`alternateIcons.icon.size`| Number enum | | Γ£ö∩╕Å | Specifies the size of the icon in pixels, enumerated as `16`,`20`,`24`,`32`,`40`,`48`,`64`,`80`. <br>Required image sizes: `16`, `32`, `80`. | |`alternateIcons.icon.url`| String | 2048 characters | Γ£ö∩╕Å | Specifies the full, absolute URL of the image file that is used to represent the add-in. Icon image must be 64 x 64 pixels and use one of the following file formats: GIF, JPG, PNG, EXIF, BMP, TIFF.| |`alternateIcons.highResolutionIcon`| Object | | Γ£ö∩╕Å | Specifies properties of the image file used to represent the add-in on high DPI screens. |-|`alternateIcons.highResolutionIcon.size`| Number enum | | Γ£ö∩╕Å | This property is reserved for future use. The value must be 64 (not 128). | +|`alternateIcons.highResolutionIcon.size`| Number enum | | Γ£ö∩╕Å | Specifies the size of the icon in pixels, enumerated as `16`,`20`,`24`,`32`,`40`,`48`,`64`,`80`. <br>Required image sizes: `16`, `32`, `80`. | |`alternateIcons.highResolutionIcon.url`| String | 2048 characters | Γ£ö∩╕Å | Specifies the full, absolute URL of the image file that is used to represent the add-in on high DPI screens. Icon image must be 128 x 128 pixels and use one of the following file formats: GIF, JPG, PNG, EXIF, BMP, TIFF.| ## actions Defines the icon properties of a given dashboard card. |Name| Type| Maximum size | Required | Description| |||||| |`iconUrl`| String | 2048 characters | | Location of the icon for the card, to be displayed in the toolbox and card bar. |-|`officeUIFabricIconName`| String | 255 characters | | Office UI Fabric or Fluent UI icon friendly name for the card. This value is used if *iconUrl* is not specified. | +|`officeUIFabricIconName`| String | 255 characters | | Office UI Fabric or Fluent UI icon friendly name for the card. This value is used if `iconUrl` is not specified. | ### dashboardCards.dashboardCard.contentSource Defines the content source of a given dashboard card. |Name| Type| Maximum size | Required | Description| ||||||-|`sourceType`| String | | | Represents the source of a card's content. Options: `bot`. +|`sourceType`| String | | | Represents the source of a card's content. Option: `bot`. |`botConfiguration`| Object | | | The configuration for the bot source. Required if the `sourceType` is set to `bot`. | #### dashboardCards.dashboardCard.contentSource.botConfiguration |
| platform | Developer Tools | https://github.com/MicrosoftDocs/msteams-docs/commits/main/msteams-platform/tabs/how-to/developer-tools.md | While the web version and the desktop version of Teams are almost same, there ar * On macOS: Select **Open Dev Tools**: :::image type="content" source="../../assets/images/dev-preview/mac-os-developer-tools.png" alt-text="Screenshot shows the option to open Dev Tools from macOS dock.":::+ + The following example shows DevTools: + :::image type="content" source="../../assets/images/dev-preview/tab-and-devtools.png" alt-text="Screenshot shows the Tab and DevTools." lightbox="../../assets/images/dev-preview/dev-tools-exp.png"::: ## Access DevTools from Android device |