Cette page a été traduite par l'API Cloud Translation.

Class CardHeader

En-tête d'un Card.

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

var 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 fiche.
`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 fiche.
`setTitle(title)`	`CardHeader`	Définit le titre de l'en-tête de la fiche.

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 : objet utilisé pour le chaînage.

`setImageStyle(imageStyle)`

Définit le recadrage de l'icône dans l'en-tête de la fiche. La valeur par défaut n'est pas recadrée. Facultatif.

Paramètres

Nom	Type	Description
`imageStyle`	`ImageStyle`	Paramètre de style.

Renvois

CardHeader : objet utilisé 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 publiquement 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'un image dans votre Google Drive, puis stockez cette chaîne pour pouvoir l'utiliser ultérieurement avec setImageUrl(imageUrl). Cette méthode évite que votre module complémentaire ait besoin d'accéder à URL de l'image disponible:

// The following assumes you have the image to use in Google Drive and have its ID.
var imageBytes = DriveApp.getFileById(imageID).getBlob().getBytes();
var 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 : objet utilisé pour le chaînage.

`setSubtitle(subtitle)`

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

Paramètres

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

Renvois

CardHeader : objet utilisé pour le chaînage.

`setTitle(title)`

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

Paramètres

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

Renvois

CardHeader : objet utilisé pour le chaînage.