This repository has been archived by the owner on Oct 23, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
sp adaptive card extension base
John Nguyen edited this page Aug 19, 2021
·
3 revisions
Home > @microsoft/sp-adaptive-card-extension-base
SharePoint Framwork Adaptive Card Extensions
This package defines the APIs for creating SPFx Adaptive Card Extensions. Adaptive Card Extensions are lightweight data focused components, which utilize Adaptive Cards to deliver rich, native experiences.
| Class | Description |
|---|---|
| AdaptiveCardExtensionContext | (BETA) Adaptive Card Extension context object. |
| BaseAdaptiveCardExtension | (BETA) Base class for Adaptive Card Extensions. |
| BaseAdaptiveCardView | (BETA) Base class for an Adaptive Card view. |
| BaseBasicCardView | (BETA) Base class for a Basic Card view. |
| BaseCardView | (BETA) Primitive base class for Card views. |
| BaseImageCardView | (BETA) Base class for an Image Card view. |
| BasePrimaryTextCardView | (BETA) Base class for a Primary Text Card view. |
| BaseView | (BETA) Base class for all views. |
| QuickViewNavigator | (BETA) Manages a stack of Adaptive Card views for the Quick view. |
| ViewNavigator | (BETA) Manages a stack of views. |
| Enumeration | Description |
|---|---|
| MediaType | (BETA) Enum value to specify the type of media. |
| Interface | Description |
|---|---|
| IAction |
(BETA) Interface copied from adaptivecard package |
| IAdaptiveCard |
(BETA) Interface copied from adaptivecard package |
| IAdaptiveCardExtensionPropertiesMetadata |
(BETA) This structure is used to define metadata for Adaptive Card Extension properties as a map of string to IAdaptiveCardExtensionPropertiesMetadata
|
| IAdaptiveCardExtensionPropertyMetadata |
(BETA) This is the structure used for map values in IAdaptiveCardExtensionPropertiesMetadata. |
| IBackgroundImage |
(BETA) Interface copied from adaptivecard package |
| IBaseActionArguments | (BETA) Base object passed to BaseView.onAction() when an Adaptive Card Action is executed. |
| IBaseCardParameters | (BETA) The primitive data parameters for every Card view. |
| IBasicCardParameters | (BETA) The data parameters for BaseBasicCardView. |
| ICardButton | (BETA) A button to display on a Card View. |
| ICardElement |
(BETA) Interface copied from adaptivecard package |
| IColumn |
(BETA) Interface copied from adaptivecard package |
| IColumnSet |
(BETA) Interface copied from adaptivecard package |
| IConfirmationDialog |
(BETA) Confirmation Dialog option that is passed through Submit Action is executed. |
| IContainer |
(BETA) Interface copied from adaptivecard package |
| IExternalLinkCardAction | (BETA) Open an external link. |
| IExternalLinkParameters | (BETA) Parameters for opening an external link. |
| IFact |
(BETA) Interface copied from adaptivecard package |
| IFactSet |
(BETA) Interface copied from adaptivecard package |
| IImage |
(BETA) Interface copied from adaptivecard package |
| IImageCardParameters | (BETA) The data parameters for BaseImageCardView. |
| IImageSet |
(BETA) Interface copied from adaptivecard package |
| IOpenUrlAction |
(BETA) Interface copied from adaptivecard package |
| IPrimaryTextCardParameters | (BETA) The data parameters for BasePrimaryTextCardView. |
| IQuickViewCardAction | (BETA) Open the quick view. |
| IQuickViewParameters | (BETA) Parameters for opening a Quick view. |
| IRichTextBlock |
(BETA) Interface for RichTextBlock. Does not exist in adaptivecard package schema types |
| ISelectMediaAction | (BETA) Interface for new Viva Select Media action |
| ISelectMediaActionArguments |
(BETA) The object passed to BaseView.onAction() when a SelectMedia Action is executed. |
| ISelectMediaActionParameters | (BETA) Parameters that can be supplied with the Viva Select Media Action. |
| ISelectMediaAttachment | (BETA) This object represents the data returned by the native media picker API. |
| ISelectMediaCardAction |
(BETA) Invoke an VivaAction.SelectMedia event. |
| IShowCardAction |
(BETA) Interface copied from adaptivecard package |
| IShowCardActionArguments |
(BETA) The object passed to BaseView.onAction() when a ShowCard Action is executed. |
| ISPFxAdaptiveCard | (BETA) SPFx Adaptive Card Extension schema. |
| ISubmitAction |
(BETA) Interface copied from adaptivecard package |
| ISubmitActionArguments |
(BETA) The object passed to BaseView.onAction() when a Submit Action is executed. |
| ISubmitCardAction |
(BETA) Invoke an Action.Submit event. |
| ISubmitCardParameters | (BETA) Parameters for submit card action. |
| ITextBlock |
(BETA) Interface copied from adaptivecard package |
| ITextRun |
(BETA) Interface does not exist in adaptivecard package |
| Type Alias | Description |
|---|---|
| ActionStyle |
(BETA) Type copied from adaptivecard package |
| CardSize | (BETA) Size of the Card view. |
| ContainerStyle |
(BETA) Type copied from adaptivecard package |
| DeviceContext |
(BETA) 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. |
| HorizontalAlignment |
(BETA) Type copied from adaptivecard package |
| IActionArguments | (BETA) The object passed to BaseView.onAction() when an Adaptive Card Action is executed. |
| ICardAction | (BETA) Type of handler for when a button is pressed. |
| ImageStyle |
(BETA) Type copied from adaptivecard package |
| Inline |
(BETA) Type does not exist in adaptivecard package |
| RenderType |
(BETA) Card is the default render View. QuickView is a more detailed view of the Adaptive Card Extension. |
| Size |
(BETA) Type copied from adaptivecard package |
| Spacing |
(BETA) Type copied from adaptivecard package |
| TextColor |
(BETA) Type copied from adaptivecard package |
| TextSize |
(BETA) Type copied from adaptivecard package |
| TextType |
(BETA) Type does not exist in adaptivecard package |
| TextWeight |
(BETA) Type copied from adaptivecard package |
| VerticalAlignment |
(BETA) Type copied from adaptivecard package |