Edit

Share via

IAdaptiveCardExtensionManifestEntry interface

  • Reference
Package:
@microsoft/sp-module-interfaces

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

This interface specifies the set of properties that can be pre-configured by a AdaptiveCardExtension developer. Each pre-configured instance of the AdaptiveCardExtension will need a copy of these properties. Organization admins and content authors can modify these properties on a need basis.

Properties

cardSize

Size of the AdaptiveCardExtension when it is rendered. This is value must be one of the supported CardSizes ["Medium", "Large"] defined in the sp-adaptive-card-base project.
dataVersion

Definition: Use this field to specify the data version of the pre-configured data provided to the AdaptiveCardExtension. Note that data version is different from the version field in the manifest.
description

Description of the AdaptiveCardExtension represented as a dictionary of locale keys to description values. This value will be displayed to the user in the toolbox. This description should be used in the Toolbox tooltip and other display areas.
groupId

The group id to determine which modern group contains the AdaptiveCardExtension in modern site page. The SharePoint Framework reserves group ids for predefined groups. The developer can pick one from those groups. If the developer fills an id not in the predefined groups, it falls back to Other group.
iconImageUrl

The icon for the AdaptiveCardExtension, to be displayed in the toolbox, represented an image URL. The image at the URL must be exactly 40x28 px (SPPPLAT VSO#218660 to fix the size of the icon image).
officeFabricIconFontName

The icon for the AdaptiveCardExtension, to be displayed in the toolbox, represented as a character name in the Office 365 icon font file.
properties

Every AdaptiveCardExtension is expected to have some custom properties. For example, a page AdaptiveCardExtension might define properties for the page URL and caption text. A list AdaptiveCardExtension may have the list ID and list title as its properties, and so on.
tags

This field is used to tag a AdaptiveCardExtension with keywords that are different from the AdaptiveCardExtension group name. Tags can be used for categorization and searching of AdaptiveCardExtensions. For example, in the toolbox.
title

Title of the AdaptiveCardExtension represented as a single a dictionary of locale keys to title values. This value will be displayed to the user in the toolbox.

Property Details

cardSize

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Size of the AdaptiveCardExtension when it is rendered. This is value must be one of the supported CardSizes ["Medium", "Large"] defined in the sp-adaptive-card-base project.

cardSize: string;

Property Value

string

dataVersion

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Definition: Use this field to specify the data version of the pre-configured data provided to the AdaptiveCardExtension. Note that data version is different from the version field in the manifest.

dataVersion?: string;

Property Value

string

Remarks

The manifest version is used to control the versioning of the AdaptiveCardExtension code, while data version is used to control the versioning of the serialized data of the AdaptiveCardExtension. Refer to dataVersion field of your AdaptiveCardExtension for more information.

Usage: versioning and evolving the serialized data of the AdaptiveCardExtension

Type: string representing a semantic version with only two parts

Supported values: MAJOR.MINOR

Example: "1.0"

description

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Description of the AdaptiveCardExtension represented as a dictionary of locale keys to description values. This value will be displayed to the user in the toolbox. This description should be used in the Toolbox tooltip and other display areas.

description: ILocalizedString;

Property Value

ILocalizedString

Remarks

The AdaptiveCardExtension developer may give an initial description to the AdaptiveCardExtension. The organization admin and page author will have the ability to change this description as per need.

Usage: display the description of the AdaptiveCardExtension in the toolbox tooltip, web part gallery and the page.

Supported values: a dictionary of locale keys to strings. Should always have a 'default' key.

Example: "A tool for displaying neat information."

         {
           "default": "A tool for displaying neat information.",
           "en-us": "A tool for displaying neat information.",
           "fr-fr": "Un outil d'affichage des informations soignées.",
           "zh": "用於顯示整潔資訊的工具。"
         }

groupId

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The group id to determine which modern group contains the AdaptiveCardExtension in modern site page. The SharePoint Framework reserves group ids for predefined groups. The developer can pick one from those groups. If the developer fills an id not in the predefined groups, it falls back to Other group.

groupId: PredefinedGroup | string;

Property Value

PredefinedGroup | string

Remarks

Supported values: the GUID from PredefinedGroup list

Example: "cf066440-0614-43d6-98ae-0b31cf14c7c3"

iconImageUrl

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The icon for the AdaptiveCardExtension, to be displayed in the toolbox, represented an image URL. The image at the URL must be exactly 40x28 px (SPPPLAT VSO#218660 to fix the size of the icon image).

iconImageUrl?: string;

Property Value

string

Remarks

If the IClientSideWebPartManifestEntry.officeFabricIconFontName field does not have a value, this field must have a value. This value can be an absolute URL (e.g. "http://example.com/icons/my-icon.png") or a relative file path (e.g. "./icons/my-icon.png"). In the latter case, the path will be resolved relative to the folder containing the input manifest. The icon file will be copied to the deployment folder like an asset, and the output manifest's iconImageUrl will be replaced with a URL relative to the URL used to load all other assets (the loaderConfig.internalModuleBaseUrls property).

Supported values: Any absolute URL.

Example: "https://contoso.akamaihd.net/files/myWebpartIcon.png"

officeFabricIconFontName

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The icon for the AdaptiveCardExtension, to be displayed in the toolbox, represented as a character name in the Office 365 icon font file.

officeFabricIconFontName?: string;

Property Value

string

Remarks

The icon font is specified here: https://aka.ms/uifabric-icons If this field has a value, the IClientSideWebPartManifestEntry.iconImageUrl field will be ignored.

Supported values: Any character name in the Office 365 Icon Font.

Example: "graph"

properties

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Every AdaptiveCardExtension is expected to have some custom properties. For example, a page AdaptiveCardExtension might define properties for the page URL and caption text. A list AdaptiveCardExtension may have the list ID and list title as its properties, and so on.

properties: TProperties;

Property Value

TProperties

Remarks

The SharePoint Framework passes these properties to the AdaptiveCardExtensions when they are loaded. The AdaptiveCardExtension developer fully controls the schema for these properties. The AdaptiveCardExtension developer should follow versioning rules when updating the properties.

Usage: rendering of the AdaptiveCardExtension

Example: {"imageSource": "https://contoso.akamaihd.net/files/contosoLogo.jpg", "captionText": "Contoso logo"}"

tags

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

This field is used to tag a AdaptiveCardExtension with keywords that are different from the AdaptiveCardExtension group name. Tags can be used for categorization and searching of AdaptiveCardExtensions. For example, in the toolbox.

tags?: ILocalizedString[];

Property Value

ILocalizedString[]

Remarks

Example [{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]

title

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Title of the AdaptiveCardExtension represented as a single a dictionary of locale keys to title values. This value will be displayed to the user in the toolbox.

title: ILocalizedString;

Property Value

ILocalizedString

Remarks

This title should be used in the Toolbox and other display areas. The AdaptiveCardExtension developer may give an initial title to the AdaptiveCardExtension. The organization admin and page author will have the ability to change this title as per need.

Usage: display the name of the AdaptiveCardExtension in the toolbox, web part gallery and the page.

Supported values: a dictionary of locale keys to strings. Should always have a 'default' key.

Example: "My Webpart"

         {
           "default": "My WebPart"
           "en-us": "My WebPart",
           "fr-fr": "Ma WebPart",
           "zh": "我的 web 部件"
         }