Class CardBuilder

CardBuilder

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 fiche.
addSection(section)CardBuilderAjoute une section à cette carte.
build()CardCrée la fiche actuelle et la valide.
setDisplayStyle(displayStyle)CardBuilderDéfinit le style d'affichage de cette fiche.
setFixedFooter(fixedFooter)CardBuilderDéfinit un pied de page fixe pour cette carte.
setHeader(cardHeader)CardBuilderDéfinit l'en-tête de cette fiche.
setName(name)CardBuilderDéfinit le nom de cette carte.
setPeekCardHeader(peekCardHeader)CardBuilderDéfinit l'en-tête de la carte de prévisualisation.

Documentation détaillée

addCardAction(cardAction)

Ajoute un CardAction à cette carte.

Paramètres

NomTypeDescription
cardActionCardActionLe CardAction à utiliser.

Renvois

CardBuilder : cet objet, pour le chaînage.


addExpressionData(expressionData)

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

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 le chaînage.


addSection(section)

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

Paramètres

NomTypeDescription
sectionCardSectionLe CardSection à utiliser.

Renvois

CardBuilder : cet objet, pour le chaînage.


build()

Crée la fiche actuelle et la valide.

Renvois

Card : carte validée.

Génère

Error : si la carte créée n'est pas valide.


setDisplayStyle(displayStyle)

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

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 fiche apparaît en bas de la barre latérale, recouvrant partiellement la fiche supérieure actuelle de la pile. Cliquer sur l'en-tête fait apparaître la carte dans la pile de cartes. Si la carte n'a 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
displayStyleDisplayStyleDisplayStyle à définir.

Renvois

CardBuilder : cet objet, pour le chaînage.


setFixedFooter(fixedFooter)

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

Paramètres

NomTypeDescription
fixedFooterFixedFooterLe FixedFooter à utiliser.

Renvois

CardBuilder : cet objet, pour le chaînage.


setHeader(cardHeader)

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

Paramètres

NomTypeDescription
cardHeaderCardHeaderLe CardHeader à utiliser.

Renvois

CardBuilder : cet objet, pour le chaînage.


setName(name)

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

Paramètres

NomTypeDescription
nameStringNom

Renvois

CardBuilder : cet objet, pour le chaînage.


setPeekCardHeader(peekCardHeader)

Définit l'en-tête de la carte de prévisualisation.

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

Paramètres

NomTypeDescription
peekCardHeaderCardHeaderCardHeader à définir.

Renvois

CardBuilder : cet objet, pour le chaînage.