Esta página foi traduzida pela API Cloud Translation.

Class CardHeader

O cabeçalho de uma Card.

Disponível para complementos do Google Workspace e apps do Google Chat.

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

Métodos

Método	Tipo de retorno	Breve descrição
`setImageAltText(imageAltText)`	`CardHeader`	Define o texto alternativo para a imagem do cabeçalho.
`setImageStyle(imageStyle)`	`CardHeader`	Define o corte do ícone no cabeçalho do cartão.
`setImageUrl(imageUrl)`	`CardHeader`	Define a imagem a ser usada no cabeçalho, fornecendo o URL ou a string de dados dela.
`setSubtitle(subtitle)`	`CardHeader`	Define a legenda do cabeçalho do cartão.
`setTitle(title)`	`CardHeader`	Define o título do cabeçalho do cartão.

Documentação detalhada

`setImageAltText(imageAltText)`

Define o texto alternativo para a imagem do cabeçalho.

Parâmetros

Nome	Tipo	Descrição
`imageAltText`	`String`	O texto alternativo para a imagem do cabeçalho.

Retorno

CardHeader: este objeto para encadeamento.

`setImageStyle(imageStyle)`

Define o corte do ícone no cabeçalho do cartão. O padrão é nenhum corte. Opcional.

Parâmetros

Nome	Tipo	Descrição
`imageStyle`	`ImageStyle`	A configuração de estilo.

Retorno

CardHeader: este objeto para encadeamento.

`setImageUrl(imageUrl)`

Define a imagem a ser usada no cabeçalho, fornecendo o URL ou a string de dados dela.

O URL fornecido pode ser de acesso público ou uma string de imagem codificada em base64. Para conseguir o último, use o código a seguir para criar uma string de imagem codificada a partir de uma imagem no Google Drive e armazene essa string para uso posterior com setImageUrl(imageUrl). Esse método evita que seu complemento precise acessar um URL de imagem disponível publicamente:

// 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).

Parâmetros

Nome	Tipo	Descrição
`imageUrl`	`String`	O endereço de URL de uma imagem hospedada ou uma string de imagem codificada.

Retorno

CardHeader: este objeto para encadeamento.

`setSubtitle(subtitle)`

Define a legenda do cabeçalho do cartão. Opcional.

Parâmetros

Nome	Tipo	Descrição
`subtitle`	`String`	O texto do subtítulo do cabeçalho.

Retorno

CardHeader: este objeto para encadeamento.

`setTitle(title)`

Define o título do cabeçalho do cartão. Obrigatório.

Parâmetros

Nome	Tipo	Descrição
`title`	`String`	O texto do cabeçalho.

Retorno

CardHeader: este objeto para encadeamento.