Edit

Share via

IAdaptiveCardExtensionManifest 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.

Extends
IClientSideComponentManifest

Properties

experimentalData

An untyped property bag for experimental flags not ready for production.
hiddenFromToolbox

If true, this AdaptiveCardExtension should not be displayed in the modern SharePoint toolbox.
preconfiguredEntries

A AdaptiveCardExtension can have pre-configured properties like the title, description, iconImageUrl, officeFabricIconFontName, toolbox group name and AdaptiveCardExtension specific custom properties. And there can be multiple instances of these pre-configured properties.
supportedHosts

Definition: An array defining what host types are supported
supportsThemeVariants

Definition: If true, this ACE supports and has been tested for theme variants experience.
useFallbackWhenPropertiesUpdatedExternally

Definition: - If true, the AdaptiveCardExtension will be disposed and reloaded when the AdaptiveCardExtension data is updated by an external source. - If false, the AdaptiveCardExtension data will be deserialized and the properties of the AdaptiveCardExtension will be updated, onAfterPropertiesUpdatedExternally will be executed. - If undefined, AdaptiveCardExtensions developed with SPFx version below 1.9 will default to true and AdaptiveCardExtensions developed with a SPFx version 1.9 or greater will default to false.

Property Details

experimentalData

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.

An untyped property bag for experimental flags not ready for production.

experimentalData?: {
        [key: string]: any;
    };

Property Value

{ [key: string]: any; }

hiddenFromToolbox

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.

If true, this AdaptiveCardExtension should not be displayed in the modern SharePoint toolbox.

hiddenFromToolbox?: boolean;

Property Value

boolean

Remarks

Usage: Use this flag if it is not appropriate to display a AdaptiveCardExtension in the modern toolbox. By default, all AdaptiveCardExtensions are enabled to be displayed in the toolbox if supportedHosts contains 'SharePointWebPart' Such AdaptiveCardExtensions can be provisioned on pages though API or be added to the page in a pre configured way.

preconfiguredEntries

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.

A AdaptiveCardExtension can have pre-configured properties like the title, description, iconImageUrl, officeFabricIconFontName, toolbox group name and AdaptiveCardExtension specific custom properties. And there can be multiple instances of these pre-configured properties.

preconfiguredEntries: IAdaptiveCardExtensionManifestEntry<TProperties>[];

Property Value

IAdaptiveCardExtensionManifestEntry<TProperties>[]

Remarks

This helps support scenarios where an organization may want to present multiple pre-configured entries for a AdaptiveCardExtension in the Toolbox. Each entry is expected to configure the AdaptiveCardExtension with a different set of pre-configured properties. A developer may decide to seed some initial values for these properties but an organization admin can go ahead and customize these properties per the needs of his/her organization. The properties can also be modified by the author of the page.

Usage: help display a AdaptiveCardExtension in the Toolbox, PropertyPane and the initial rendering of the AdaptiveCardExtension.

Type: JSON object

Supported values: Array of IClientSideWebPartManifestEntry objects.

Example:

  [{
     "groupId": "5c03119e-3074-46fd-976b-c60198311f70",
     "group": { "default": "Advanced" },
     "title": { "id": "$./ManifestStrings.resx:PrimaryTextL1Template;" },
     "description": { "id": "$./ManifestStrings.resx:PrimaryTextL1TemplateDescription;" },
     "officeFabricIconFontName": "Balloons",
     "properties": {
       "templateType": "primaryText",
       "title": "Primary Text",
       "primaryText": "Basic card",
       "description": "This is an example.",
       "cardSize": "Medium"
     }
   }]

supportedHosts

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: An array defining what host types are supported

supportedHosts?: ReadonlyArray<'Dashboard'>;

Property Value

ReadonlyArray<'Dashboard'>

Remarks

Usage: Use this array to define all hosts that are supported.

supportsThemeVariants

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: If true, this ACE supports and has been tested for theme variants experience.

supportsThemeVariants?: boolean;

Property Value

boolean

Remarks

Usage: Use this flag if a ACE supports theme variants and has been tested as such. In order to support theme variants, ACEs must have the capability to render correctly in the context of a theme variant. An ACE may or may not need to be updated to support theme variants, but should always be tested before enabling this flag. By default no ACEs support theme variants.

useFallbackWhenPropertiesUpdatedExternally

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: - If true, the AdaptiveCardExtension will be disposed and reloaded when the AdaptiveCardExtension data is updated by an external source. - If false, the AdaptiveCardExtension data will be deserialized and the properties of the AdaptiveCardExtension will be updated, onAfterPropertiesUpdatedExternally will be executed. - If undefined, AdaptiveCardExtensions developed with SPFx version below 1.9 will default to true and AdaptiveCardExtensions developed with a SPFx version 1.9 or greater will default to false.

useFallbackWhenPropertiesUpdatedExternally?: boolean;

Property Value

boolean

Remarks

By default, onAfterPropertiesUpdatedExternally will re-render the AdaptiveCardExtension. If your AdaptiveCardExtension requires specialized logic, then it is recommended to override onAfterPropertiesUpdatedExternally.