BaseAdaptiveCardExtension class

Paquet:

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

Classe de base pour les extensions de carte adaptative.

Extends

BaseComponent

Remarques

Les extensions de carte adaptative doivent hériter de cette classe.

Constructeurs

(constructor)()

Construit une nouvelle instance de la BaseAdaptiveCardExtension classe

Propriétés

_iconProperty
_title
cardNavigator	ViewNavigator pour l’affichage Carte.
cardSize	CardSize actuel.
context	Consultez BaseComponent.context.
dataVersion	La valeur de cette propriété est stockée dans les données sérialisées de l’extension de carte adaptative. Il peut être utilisé pour gérer le contrôle de version de l’extension de carte adaptative.
description	Description de l’extension de carte adaptative définie dans le manifeste.
displayMode	DisplayMode actuel.
iconProperty	URL de l’icône utilisée pour afficher une icône dans l’affichage Carte.
isRenderAsync	Indique si l’ace est rendu en mode asynchrone.
isVisible	Définit la visibilité de l’extension de carte adaptative et le rendu
navigator	ViewNavigator actuel.
properties	Propriétés personnalisées persistantes de l’extension de carte adaptative.
propertiesMetadata	Cette propriété définit les métadonnées du conteneur de propriétés d’extension de carte adaptative. Les métadonnées peuvent aider SharePoint à mieux comprendre le contenu des propriétés et à effectuer des services pertinents sur les données.
quickViewNavigator	QuickViewNavigator est un ViewNavigator pour l’affichage rapide.
renderedFromPersistedData	Indique si l’extension de carte adaptative a été rendue à partir de données persistantes ou initialisée à partir d’un état par défaut.
renderedOnce	Indique si l’extension de carte adaptative a été rendue initialement.
renderType	RenderType actuel.
state	Obtient l’état personnalisé de l’extension de carte adaptative.
title	Cette valeur s’affiche en mode Carte et Rapide, sauf si elle est explicitement remplacée par les vues. Il s’affiche également en tant que titre du volet de propriétés.

Méthodes

getCachedState(state)	Cette méthode virtuelle retourne un sous-ensemble de l’objet d’état qui sera mis en cache par le client.
getCacheSettings()	Remplacez les paramètres de cache par défaut.
getPropertyPaneConfiguration()	Obtenez la configuration du volet de propriétés pour cette extension de carte adaptative. Si une extension de carte adaptative souhaite utiliser le volet de propriétés, cette méthode doit être remplacée.
loadPropertyPaneResources()	API permettant d’activer le chargement asynchrone des ressources associées au volet de propriétés de l’extension de carte adaptative.
onAfterDeserialize(deserializedProperties, dataVersion)	Méthode de cycle de vie appelée avant que le conteneur de propriétés ne soit rempli avec l’objet de propriété désérialisé.
onAfterPropertiesUpdatedExternally(prevProperties)	Méthode de cycle de vie appelée après la mise à jour des propriétés de l’extension de carte adaptative par une source autre que le volet de propriétés (à l’exception des extensions de carte adaptative isolées).
onBeforeAction(action)	Méthode de cycle de vie appelée avant le passage d’Action à IAdaptiveCardExtensionActionView.onAction.
onBeforeSerialize()	Méthode de cycle de vie appelée avant la sérialisation.
onDisplayModeChanged(oldDisplayMode)	Méthode de cycle de vie appelée après la modification de DisplayMode .
onDispose()	Méthode de cycle de vie appelée avant de supprimer l’extension de carte adaptative.
onInit()	Méthode de cycle de vie appelée lors de l’initialisation.
onInit(cachedLoadParameters)	Méthode de cycle de vie appelée lors de l’initialisation.
onNotificationReceived(notificationArguments)	Méthode de cycle de vie appelée lors de la réception d’une notification pour cette extension de carte adaptative.
onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)	Méthode de cycle de vie appelée lorsqu’un champ Volet de propriétés est modifié.
onRenderTypeChanged(oldRenderType)	Méthode de cycle de vie appelée lorsque le RenderType change.
renderCard()	ID de la vue Carte initiale.
renderCompleted(didUpdate)	Méthode de cycle de vie qui signifie qu’ACE a terminé le chargement. Lorsque cette API est appelée, les données de performances sont générées. En fonction didUpdate du paramètre, le marqueur de fin du cycle de vie du rendu peut changer. Si un ACE a reçu des données LKG et n’a PAS besoin d’être mis à jour, le rendu est terminé lorsque LKG est utilisé. Si un ACE a reçu des données LKG et a besoin d’être mis à jour, le rendu est terminé lorsque de nouveaux arguments de rendu sont utilisés. Si un ACE ne reçoit pas de données LKG, le rendu est terminé lorsque de nouveaux arguments de rendu sont utilisés.
setState(newState)	Mettez à jour l’état de l’extension de carte adaptative et restituez le rendu.

Détails du constructeur

(constructor)()

Construit une nouvelle instance de la BaseAdaptiveCardExtension classe

constructor();

Détails de la propriété

_iconProperty

protected _iconProperty: string;

Valeur de propriété

string

_title

protected _title: string;

Valeur de propriété

string

cardNavigator

ViewNavigator pour l’affichage Carte.

get cardNavigator(): IViewNavigator<BaseCardView<TProperties, TState>>;

Valeur de propriété

IViewNavigator<BaseCardView<TProperties, TState>>

cardSize

CardSize actuel.

protected get cardSize(): CardSize;

Valeur de propriété

CardSize

context

Consultez BaseComponent.context.

protected context: AdaptiveCardExtensionContext;

Valeur de propriété

AdaptiveCardExtensionContext

dataVersion

La valeur de cette propriété est stockée dans les données sérialisées de l’extension de carte adaptative. Il peut être utilisé pour gérer le contrôle de version de l’extension de carte adaptative.

protected get dataVersion(): Version;

Valeur de propriété

Version

Remarques

La version par défaut est 1.0.

description

Description de l’extension de carte adaptative définie dans le manifeste.

protected get description(): string;

Valeur de propriété

string

displayMode

DisplayMode actuel.

get displayMode(): DisplayMode;

Valeur de propriété

DisplayMode

iconProperty

URL de l’icône utilisée pour afficher une icône dans l’affichage Carte.

/** @virtual */
get iconProperty(): string;

Valeur de propriété

string

Remarques

Par défaut, cela renvoie l’icôneImageUrl définie dans le manifeste.

isRenderAsync

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Indique si l’ace est rendu en mode asynchrone.

protected get isRenderAsync(): boolean;

Valeur de propriété

boolean

Remarques

Si l’ACE remplace ce champ pour retourner true, il doit appeler l’API renderCompleted une fois l’initialisation de l’ACE terminée.

La valeur par défaut est false.

isVisible

Définit la visibilité de l’extension de carte adaptative et le rendu

get isVisible(): boolean;

set isVisible(value: boolean);

Valeur de propriété

boolean

Remarques

Cette méthode doit être appelée après l’inscription d’une vue carte. Sinon, la modification de la visibilité ne sera pas appliquée à la carte adaptative.

navigator

ViewNavigator actuel.

get navigator(): IViewNavigator<BaseView<TProperties, TState>>;

Valeur de propriété

IViewNavigator<BaseView<TProperties, TState>>

Remarques

Si l’objet BaseAdaptiveCardExtension.renderType actuel est QuickView alors renvoyé BaseAdaptiveCardExtension.quickViewNavigator<--

properties

Propriétés personnalisées persistantes de l’extension de carte adaptative.

protected get properties(): TProperties;

Valeur de propriété

TProperties

propertiesMetadata

Cette propriété définit les métadonnées du conteneur de propriétés d’extension de carte adaptative. Les métadonnées peuvent aider SharePoint à mieux comprendre le contenu des propriétés et à effectuer des services pertinents sur les données.

/** @virtual */
protected get propertiesMetadata(): IAdaptiveCardExtensionPropertiesMetadata | undefined;

Valeur de propriété

IAdaptiveCardExtensionPropertiesMetadata | undefined

Remarques

Pour plus d’informations sur la définition des métadonnées, consultez IAdaptiveCardExtensionPropertiesMetadata .

quickViewNavigator

QuickViewNavigator est un ViewNavigator pour l’affichage rapide.

get quickViewNavigator(): IQuickViewNavigator<BaseQuickView<TProperties, TState>>;

Valeur de propriété

IQuickViewNavigator<BaseQuickView<TProperties, TState>>

renderedFromPersistedData

Indique si l’extension de carte adaptative a été rendue à partir de données persistantes ou initialisée à partir d’un état par défaut.

protected get renderedFromPersistedData(): boolean;

Valeur de propriété

boolean

renderedOnce

Indique si l’extension de carte adaptative a été rendue initialement.

get renderedOnce(): boolean;

Valeur de propriété

boolean

renderType

RenderType actuel.

get renderType(): RenderType;

Valeur de propriété

RenderType

state

Obtient l’état personnalisé de l’extension de carte adaptative.

protected get state(): Readonly<TState>;

protected set state(initialState: Readonly<TState>);

Valeur de propriété

Readonly<TState>

Remarques

Cette propriété ne doit pas être mise à jour directement. Utilisez BaseAdaptiveCardExtension.setState() pour mettre à jour l’état après l’initialisation.

title

Cette valeur s’affiche en mode Carte et Rapide, sauf si elle est explicitement remplacée par les vues. Il s’affiche également en tant que titre du volet de propriétés.

/** @virtual */
get title(): string;

Valeur de propriété

string

Remarques

Par défaut, le titre défini dans le manifeste est retourné.

Détails de la méthode

getCachedState(state)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Cette méthode virtuelle retourne un sous-ensemble de l’objet d’état qui sera mis en cache par le client.

/** @virtual */
protected getCachedState(state: TState): Partial<TState>;

Paramètres

state

TState

Clone superficiel de l’objet d’état AdaptiveCardExtension.

Retours

Partial<TState>

Remarques

S’il n’est pas substitué, un objet vide est retourné.

getCacheSettings()

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Remplacez les paramètres de cache par défaut.

/** @virtual */
protected getCacheSettings(): Partial<ICacheSettings>;

Retours

Partial<ICacheSettings>

getPropertyPaneConfiguration()

Obtenez la configuration du volet de propriétés pour cette extension de carte adaptative. Si une extension de carte adaptative souhaite utiliser le volet de propriétés, cette méthode doit être remplacée.

/** @virtual */
protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration;

Retours

IPropertyPaneConfiguration

Remarques

Les ressources du volet de propriétés peuvent être chargées pour réduire la taille de l’offre groupée. Consultez BaseAdaptiveCardExtension.loadPropertyPaneResources()<--

loadPropertyPaneResources()

API permettant d’activer le chargement asynchrone des ressources associées au volet de propriétés de l’extension de carte adaptative.

/** @virtual */
protected loadPropertyPaneResources(): Promise<void>;

Retours

Promise<void>

Remarques

Aucun événement du volet de propriétés n’est déclenché tant que cette méthode n’est pas résolue, à l’exception de PropertyPaneConfigurationComplete, qui peut être utilisé pour propre toutes les ressources en attente.

onAfterDeserialize(deserializedProperties, dataVersion)

Méthode de cycle de vie appelée avant que le conteneur de propriétés ne soit rempli avec l’objet de propriété désérialisé.

/** @virtual */
protected onAfterDeserialize(deserializedProperties: any, dataVersion: Version): TProperties;

Paramètres

deserializedProperties

any

Objet désérialisé des données stockées. Notez que le schéma de cet objet n’est pas nécessairement cohérent avec le conteneur de propriétés actuel, car la sérialisation aurait pu être effectuée par une version antérieure de l’extension de carte adaptative

dataVersion

Version

Version des données stockées en cours de désérialisation. Vous pouvez utiliser cette valeur pour déterminer si les données ont été sérialisées par une ancienne extension de carte adaptative. Les extensions de carte adaptative peuvent définir leur version de données en remplaçant la propriété dataVersion.

Retours

TProperties

Conteneur de propriétés de l’extension de carte adaptative

Remarques

L’implémentation par défaut est une absence d’opération. Un développeur d’extension de carte adaptative peut remplacer cette API si l’objet désérialisé ne reflète pas entièrement l’état initial du conteneur de propriétés. Cela permet au développeur de l’extension de carte adaptative de remplir le conteneur de propriétés juste après la désérialisation des données dans un objet.

La mise à niveau est un scénario important à utiliser pour désérialiser. Une extension de carte adaptative mise à niveau peut charger les données sérialisées par une version antérieure de l’extension de carte adaptative qui a pris en charge un schéma différent du conteneur de propriétés, ce qui entraîne l’incosistante de l’objet désérialisé avec le schéma actuel du conteneur de propriétés. Le développeur peut utiliser onAfterDeserialize pour case activée dataVersion et corriger le conteneur de propriétés.

onAfterPropertiesUpdatedExternally(prevProperties)

Méthode de cycle de vie appelée après la mise à jour des propriétés de l’extension de carte adaptative par une source autre que le volet de propriétés (à l’exception des extensions de carte adaptative isolées).

/** @virtual */
onAfterPropertiesUpdatedExternally(prevProperties: TProperties): void;

Paramètres

prevProperties

TProperties

Propriétés de l’extension de carte adaptative avant la mise à jour.

Retours

void

Remarques

Pour les extensions de carte adaptative isolées, ce cycle de vie est appelé au lieu de onPropertyPaneFieldChanged.

onBeforeAction(action)

Méthode de cycle de vie appelée avant le passage d’Action à IAdaptiveCardExtensionActionView.onAction.

/** @virtual */
onBeforeAction(action: IOnBeforeActionArguments): void;

Paramètres

action

IOnBeforeActionArguments

IOnBeforeActionArguments pour l’action actuelle.

Retours

void

Remarques

Cette méthode n’est pas destinée à être utilisée pour annuler l’action ou modifier le flux.

onBeforeSerialize()

Méthode de cycle de vie appelée avant la sérialisation.

/** @virtual */
onBeforeSerialize(): void;

Retours

void

onDisplayModeChanged(oldDisplayMode)

Méthode de cycle de vie appelée après la modification de DisplayMode .

/** @virtual */
protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void;

Paramètres

oldDisplayMode

DisplayMode

Ancien mode d’affichage.

Retours

void

onDispose()

Méthode de cycle de vie appelée avant de supprimer l’extension de carte adaptative.

/** @virtual */
onDispose(): void;

Retours

void

onInit()

Méthode de cycle de vie appelée lors de l’initialisation.

/** @virtual */
onInit(): Promise<void>;

Retours

Promise<void>

Remarques

Les extractions de données asynchrones doivent être démarrées pendant ce cycle de vie. Le rendu peut être dépendant du résultat ou, s’il est résolu immédiatement, un état de récupération des données peut être rendu.

onInit(cachedLoadParameters)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Méthode de cycle de vie appelée lors de l’initialisation.

/** @virtual */
onInit(cachedLoadParameters?: ICachedLoadParameters): Promise<void>;

Paramètres

cachedLoadParameters

ICachedLoadParameters

Paramètres contenant l’objet d’état mis en cache (voir BaseAdaptiveCardExtension.getCachedState()), qui peuvent être utilisés pour réhydrater l’AdaptiveCardExtension. Si elle n’est pas définie, l’AdaptiveCardExtension n’a pas été mise en cache ou le cache a expiré.

Retours

Promise<void>

Remarques

Les extractions de données asynchrones doivent être démarrées pendant ce cycle de vie. Le rendu peut être dépendant du résultat ou, s’il est résolu immédiatement, un état de récupération des données peut être rendu.

onNotificationReceived(notificationArguments)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Méthode de cycle de vie appelée lors de la réception d’une notification pour cette extension de carte adaptative.

/** @virtual */
onNotificationReceived(notificationArguments: Readonly<INotificationArguments<{}>>): INotificationResponse | undefined;

Paramètres

notificationArguments

Readonly<INotificationArguments<{}>>

INotificationArguments pour l’événement de notification actuel.

Retours

INotificationResponse | undefined

ID d’affichage rapide inscrit à ouvrir ou non défini.

Remarques

Une seule extension de carte adaptative peut gérer un événement de notification. Si l’événement est géré, la propagation est terminée.

onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)

Méthode de cycle de vie appelée lorsqu’un champ Volet de propriétés est modifié.

/** @virtual */
protected onPropertyPaneFieldChanged(propertyPath: string, oldValue: any, newValue: any): void;

Paramètres

propertyPath

string

Chemin d’accès JSON de la propriété dans le conteneur des propriétés. Dans le cas d’un champ personnalisé, si aucune propriété cible n’est fournie, une valeur personnalisée est affectée, qui se présente sous la forme .__CustomField_<key provided when the custom field is created>

oldValue

any

Ancienne valeur de la propriété. Cette valeur peut être non définie/vide dans le cas d’un champ personnalisé.

newValue

any

Nouvelle valeur de la propriété. Cette valeur peut être non définie/vide dans le cas d’un champ personnalisé.

Retours

void

Remarques

Il est appelé pour les volets de propriétés réactifs.

onRenderTypeChanged(oldRenderType)

Méthode de cycle de vie appelée lorsque le RenderType change.

/** @virtual */
protected onRenderTypeChanged(oldRenderType: RenderType): void;

Paramètres

oldRenderType

RenderType

RenderType précédent.

Retours

void

renderCard()

ID de la vue Carte initiale.

/** @virtual */
protected renderCard(): string | undefined;

Retours

string | undefined

Remarques

Par défaut, cela retourne undefined et affiche une vue Carte par défaut.

renderCompleted(didUpdate)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Méthode de cycle de vie qui signifie qu’ACE a terminé le chargement. Lorsque cette API est appelée, les données de performances sont générées. En fonction didUpdate du paramètre, le marqueur de fin du cycle de vie du rendu peut changer. Si un ACE a reçu des données LKG et n’a PAS besoin d’être mis à jour, le rendu est terminé lorsque LKG est utilisé. Si un ACE a reçu des données LKG et a besoin d’être mis à jour, le rendu est terminé lorsque de nouveaux arguments de rendu sont utilisés. Si un ACE ne reçoit pas de données LKG, le rendu est terminé lorsque de nouveaux arguments de rendu sont utilisés.

renderCompleted(didUpdate: boolean): void;

Paramètres

didUpdate

boolean

valeur booléenne indiquant si ACE a été mis à jour.

Retours

void

setState(newState)

Mettez à jour l’état de l’extension de carte adaptative et restituez le rendu.

setState(newState?: Partial<TState>): void;

Paramètres

newState

Partial<TState>

Nouvel état à définir.

Retours

void

Remarques

BaseAdaptiveCardExtension.state doit avoir été initialisé avant d’appeler BaseAdaptiveCardExtension.setState()<--