@microsoft/sp-adaptive-card-extension-base package

Adaptive Card Extension context object.

Base class for Adaptive Card Extensions.

Base class for an Adaptive Card quick view.

Base class for an Adaptive Card quick view.

Base class for a Basic Card view.

Primitive base class for Card views.

Base class for an component-based Card views.

Base class for an Image Card view.

Base class for a Primary Text Card view.

Base class for an Adaptive Card view.

Primitive base class for template-based Card views.

Base class for all views.

Base class for a Web Quick view.

Manages a stack of Adaptive Card views for the Quick view.

Manages a stack of views.

The interface describes members for views that can handle AC actions.

The interface defines properties for view that specify configuration as data property.

Properties for the image rendered in a card view.

This structure is used to define metadata for Adaptive Card Extension properties as a map of string to IAdaptiveCardExtensionPropertiesMetadata

This is the structure used for map values in IAdaptiveCardExtensionPropertiesMetadata.

This object represents error associated with a single attachment

Represents the parameters for an axis on a chart.

Configuration for a bar chart card view.

Series for a bar chart.

Base object passed to IAdaptiveCardExtensionActionView.onAction when an Adaptive Card Action is executed.

Base object passed to IAdaptiveCardExtensionActionView.onActionError when an Adaptive Card OnActionError is executed.

Base parameters for a data visualization component.

The primitive data parameters for every Card view.

Base object passed to BaseAdaptiveCardExtension.onBeforeAction().

Generic series for data visualization.

The data parameters for BaseBasicCardView.

Configuration for a Basic Card view.

Parameters used to rehydrate the AdaptiveCardExtension during a cached load

Configuration for a bar chart.

Parameters for a bar chart.

Card view title area (card bar) component configuration.

Card view title area (card bar) component parameters

A button to display on a Card View.

Base properties for the buttons used in different ACE card view components, such as Text Input and Search Box and Card Button.

Card button component configuration.

Card button component parameters.

Base card view component parameters.

Configuration for a line chart.

Parameters for a line chart.

Configuration for a pie chart.

Parameters for a pie chart.

Search box button properties.

Search box component configuration.

Search box component parameters. Represents a search box rendered in the card view.

Search box footer component configuration.

Search footer component parameters. Represents a container with an image (in the shape of a circle) and text.

Text component configuration.

Text input component configuration.

Text input icon button.

Text input component parameters.

Text input title button.

Text component parameters. Represents a text block rendered in the card view.

Card view configuration

Card view configuration parameters. The configuration specifies how the card view is rendered.

Parameters for a Cartesian chart component with X and Y axes.

Confirmation Dialog option that is passed through Submit Action is executed.

Data point for data visualization.

Configuration for a DataVisualization card view.

The parameters for the DataVisualization card view.

The object passed to IAdaptiveCardExtensionActionView.onAction when a Execute Action is executed. https://adaptivecards.io/explorer/Action.Execute.html

Invoke an Action.Execute event.

Parameters for Execute card action.

The object passed to BaseAdaptiveCardExtension.onBeforeAction() when a ExternalLink Action is triggered.

Open an external link.

Parameters for opening an external link.

Interface to give third party developers the capability to determine which element should recieve focus, when, and how often content should be read.

Interface for Viva Get Location action

The object passed to IAdaptiveCardExtensionActionView.onAction when a Get location Action is executed.

Parameters that can be supplied with the Viva Get Location Action.

Invoke an VivaAction.GetLocation event.

The data parameters for BaseImageCardView.

Configuration for an Image Card view.

Configuration for a line chart card view.

Series for a line chart.

Interface for location coordinates

This object represents the error data that the Location action can throw.

The object passed to BaseAdaptiveCardExtension.onNotificationReceived() when a notification is received.

The object returned from BaseAdaptiveCardExtension.onNotificationReceived() if it has handled the notification.

Provides access to the Teams SDK and Teams context. Only provided when the web part is loaded in Teams.

Currently We are providing only Partial Contextual Information.

Conditional set of SDKs provided by SPFx dependent on the environment.

Currently we are providing only Partial SDKs.

Partial teams context

Provides access to the Teams SDK and Teams context. Only provided when the web part is loaded in Teams.

Configuration for a pie chart card view.

Series for a pie chart.

Data point for Pie data visualization components.

The data parameters for BasePrimaryTextCardView.

Configuration for a Primary Text Card view.

The object passed to BaseAdaptiveCardExtension.onBeforeAction() when a QuickView Action is triggered.

Open the quick view.

Properties describing a QuickViewNavigator

Parameters for opening a Quick view.

Configuration for a Search Card view.

The parameters for the search card view.

Interface for new Viva Select Media action

The object passed to IAdaptiveCardExtensionActionView.onAction when a SelectMedia Action is executed.

This object represents the data returned by the native media picker API.

Parameters that can be supplied with the Viva Select Media Action.

This object represents the data returned by the native media picker API.

Invoke an VivaAction.SelectMedia event.

The object passed to IAdaptiveCardExtensionActionView.onAction when a ShowCard Action is executed.

Interface for Viva Show Location action

The object passed to BaseAdaptiveCardExtension.onBeforeAction() when a ShowLocation Action is triggered.

Parameters that can be supplied with the Viva Show Location Action.

Invoke an VivaAction.ShowLocation event.

SPFx Adaptive Card Extension schema for Adaptive Cards.

The object passed to IAdaptiveCardExtensionActionView.onAction when a Submit Action is executed.

Invoke an Action.Submit event.

Parameters for submit card action.

The parameters for the card view with text or empty body.

Configuration for an Text Input Card View

*

The parameters for the card view with text input in the body.

Configuration for an Text Input Card View

*

Properties describing a ViewNavigator

Utility type to define what valid types of data can be used in a bar chart data visualization.

Base type to enforce correct type of arguments passed to BaseAdaptiveCardExtension.onBeforeAction().

Base component configuration.

List of all events supported by components.

Names of the components allowed in a card view.

Supported data visualizations to render on the card view.

Event names supported by the search box component.

Size of the Card view.

Event names supported by the text input component.

The actions-only footer configuration for the card view.

The actions-only footer parameters for the card view.

Card view configuration type.

WebView indicates the Adaptive Card Extension is rendering through a web browser equivalent. Mobile indicates the Adaptive Card Extension is rendering natively on a mobile platform.

The footer configuration for the Generic card view templates.

The footer parameters for the Generic card view templates. Can contain either 0 to 2 buttons or a single text input.

The object passed to IAdaptiveCardExtensionActionView.onAction when an Adaptive Card Action is executed.

The object passed to IAdaptiveCardExtensionActionView.onActionError when an error occured while executing Adaptive Card Action.

Card view icon.

Type of handler for when a button is pressed.

The object passed to BaseAdaptiveCardExtension.onBeforeAction() when an Adaptive Card Action is executed.

Utility type to define what valid types of data can be used in a line chart data visualization.

Utility type to enforce a tuple with a maximum length of 3.

Card is the default render View. QuickView is a more detailed view of the Adaptive Card Extension.

Set of supported types for the data used with the bar chart data visualization.

Set of supported types for the data used with the line chart data visualization.

Enum value to specify the type of media.

Helper method to create a bar chart card view with numeric data.

Helper method to create a bar chart card view with string data.

Helper method to create a bar chart card view with date data.

Helper method to create a Basic Card View.

Helper method to create an Image Card View.

Helper method to create a line chart card view with numeric data.

Helper method to create a line chart card view with date data.

Helper method to create a pie chart card view

Helper method to create a Primary Text Card View.

Helper method to create a Search Card View.

Helper method to create an Text Input Card View.

Helper method to create an Text Input with Image Card View.