Class CardBuilder

CardBuilder

Un compilateur pour les objets Card.

Méthodes

MéthodeType renvoyéBrève description
addCardAction(cardAction)CardBuilderAjoute un CardAction à cette carte.
addExpressionData(expressionData)CardBuilderAjoute des données d'expression à cette carte.
addSection(section)CardBuilderAjoute une section à cette carte.
build()CardCrée la carte actuelle et la valide.
setDisplayStyle(displayStyle)CardBuilderDéfinit le style d'affichage de cette carte.
setFixedFooter(fixedFooter)CardBuilderDéfinit un pied de page fixe pour cette carte.
setHeader(cardHeader)CardBuilderDéfinit l'en-tête de cette carte.
setName(name)CardBuilderDéfinit le nom de cette carte.
setPeekCardHeader(peekCardHeader)CardBuilderDéfinit l'en-tête de la carte d'aperçu.

Documentation détaillée

addCardAction(cardAction)

Ajoute une CardAction à cette carte.

Paramètres

NomTypeDescription
cardActionCardActionLe CardAction à utiliser.

Renvois

CardBuilder : cet objet, pour l'association en chaîne.


addExpressionData(expressionData)

Ajoute des données d'expression à cette carte.

ExpressionData définit la logique et la condition CEL, ainsi que l'événement à déclencher lorsqu'une condition est remplie.

Paramètres

NomTypeDescription
expressionDataExpressionDataLe ExpressionData à utiliser.

Renvois

CardBuilder : cet objet, pour l'association en chaîne.


addSection(section)

Ajoute une section à cette carte. Vous ne pouvez pas ajouter plus de 100 sections à une carte.

Paramètres

NomTypeDescription
sectionCardSectionLe CardSection à utiliser.

Renvois

CardBuilder : cet objet, pour l'association en chaîne.


build()

Crée la carte actuelle et la valide.

Renvois

Card : une carte validée.

Génère

Error : si la carte construite n'est pas valide.


setDisplayStyle(displayStyle)

Définit le style d'affichage de cette carte.

Si le style d'affichage est défini sur DisplayStyle.REPLACE, la carte s'affiche en remplaçant la vue de la carte supérieure dans la pile de cartes.

Si le style d'affichage est défini sur DisplayStyle.PEEK, l'en-tête de la carte apparaît en bas de la barre latérale, couvrant partiellement la carte supérieure actuelle de la pile. Cliquez sur l'en-tête pour afficher la carte dans la pile de cartes. Si la carte ne comporte pas d'en-tête, un en-tête généré est utilisé à la place.

DisplayStyle ne fonctionne que pour les cartes renvoyées par la fonction de déclencheur contextuel.

Paramètres

NomTypeDescription
displayStyleDisplayStyleLe DisplayStyle à définir.

Renvois

CardBuilder : cet objet, pour l'association en chaîne.


setFixedFooter(fixedFooter)

Définit un pied de page fixe pour cette carte.

Paramètres

NomTypeDescription
fixedFooterFixedFooterLe FixedFooter à utiliser.

Renvois

CardBuilder : cet objet, pour l'association en chaîne.


setHeader(cardHeader)

Définit l'en-tête de cette carte.

Paramètres

NomTypeDescription
cardHeaderCardHeaderLe CardHeader à utiliser.

Renvois

CardBuilder : cet objet, pour l'association en chaîne.


setName(name)

Définit le nom de cette carte. Le nom peut être utilisé pour la navigation.

Paramètres

NomTypeDescription
nameStringLe nom.

Renvois

CardBuilder : cet objet, pour l'association en chaîne.


setPeekCardHeader(peekCardHeader)

Définit l'en-tête de la carte d'aperçu.

La carte d'aperçu est définie sur la première carte renvoyée par une fonction de déclencheur contextuel. Elle est utilisée comme widget d'espace réservé descriptif afin que les utilisateurs puissent passer d'une pile de la page d'accueil à la pile contextuelle.

Paramètres

NomTypeDescription
peekCardHeaderCardHeaderLe CardHeader à définir.

Renvois

CardBuilder : cet objet, pour l'association en chaîne.