Class CardHeader

CardHeader

En-tête d'un Card.

Disponible pour les modules complémentaires Google Workspace et les applications Google Chat.

const cardHeader = CardService.newCardHeader()
                       .setTitle('Card header title')
                       .setSubtitle('Card header subtitle')
                       .setImageStyle(CardService.ImageStyle.CIRCLE)
                       .setImageUrl('https://image.png');

Méthodes

Méthode	Type renvoyé	Brève description
setImageAltText(imageAltText)	CardHeader	Définit le texte alternatif de l'image d'en-tête.
setImageStyle(imageStyle)	CardHeader	Définit le recadrage de l'icône dans l'en-tête de la carte.
setImageUrl(imageUrl)	CardHeader	Définit l'image à utiliser dans l'en-tête en fournissant son URL ou sa chaîne de données.
setSubtitle(subtitle)	CardHeader	Définit le sous-titre de l'en-tête de la carte.
setTitle(title)	CardHeader	Définit le titre de l'en-tête de la carte.

Documentation détaillée

setImageAltText(imageAltText)

Définit le texte alternatif de l'image d'en-tête.

Paramètres

Nom	Type	Description
imageAltText	String	Texte alternatif de l'image d'en-tête.

Renvois

CardHeader : cet objet, pour le chaînage.

---

setImageStyle(imageStyle)

Définit le recadrage de l'icône dans l'en-tête de la carte. Par défaut, aucune zone de recadrage n'est définie. Facultatif.

Paramètres

Nom	Type	Description
imageStyle	ImageStyle	Paramètre de style.

Renvois

CardHeader : cet objet, pour le chaînage.

---

setImageUrl(imageUrl)

Définit l'image à utiliser dans l'en-tête en fournissant son URL ou sa chaîne de données.

L'URL fournie peut être une URL accessible au public ou une chaîne d'image encodée en base64. Pour obtenir ce dernier, vous pouvez utiliser le code suivant afin de créer une chaîne d'image encodée à partir d'une image dans votre Google Drive, puis stocker cette chaîne pour l'utiliser ultérieurement avec setImageUrl(imageUrl). Cette méthode évite à votre module complémentaire d'accéder à une URL d'image accessible au public :

// The following assumes you have the image to use in Google Drive and have its
// ID.
const imageBytes = DriveApp.getFileById('123abc').getBlob().getBytes();
const encodedImageURL =
    `data:image/jpeg;base64,${Utilities.base64Encode(imageBytes)}`;

// You can store encodeImageURL and use it as a parameter to
// CardHeader.setImageUrl(imageUrl).

Paramètres

Nom	Type	Description
imageUrl	String	Adresse URL d'une image hébergée à utiliser ou chaîne d'image encodée.

Renvois

CardHeader : cet objet, pour le chaînage.

---

setSubtitle(subtitle)

Définit le sous-titre de l'en-tête de la carte. Facultatif.

Paramètres

Nom	Type	Description
subtitle	String	Texte du sous-titre de l'en-tête.

Renvois

CardHeader : cet objet, pour le chaînage.

---

setTitle(title)

Définit le titre de l'en-tête de la carte. Obligatoire.

Paramètres

Nom	Type	Description
title	String	Texte de l'en-tête.

Renvois

CardHeader : cet objet, pour le chaînage.