Card Service

Serviço de cartão

Esse serviço permite que os scripts configurem e criem componentes e comportamentos de cards e widgets para uma IU. As estruturas da IU que você cria com esse serviço são disponíveis automaticamente em computadores e dispositivos móveis. Assim, não é necessário desenvolver IUs separadas para ambas.

Classes

NomeBreve descrição
ActionUma ação que permite interatividade nos elementos da IU.
ActionResponseO objeto de resposta que pode ser retornado por uma função de retorno de chamada (por exemplo, um gerenciador de respostas de formulário) para executar uma ou mais ações no cliente.
ActionResponseBuilderUm builder para objetos ActionResponse.
AttachmentRepresenta um anexo criado por um complemento.
AuthorizationActionUma ação de autorização que enviará o usuário para o AuthorizationUrl quando clicado.
AuthorizationExceptionUm erro que pode ser retornado para acionar um cartão de autorização que será exibido ao usuário.
BorderStyleUma classe que representa um estilo de borda completo que pode ser aplicado a widgets.
BorderTypeUma enumeração que representa os tipos de borda que podem ser aplicados a widgets.
ButtonUma classe base para todos os botões.
ButtonSetMantém um conjunto de objetos Button exibidos em uma linha.
CalendarEventActionResponseRepresenta uma resposta que faz alterações no evento da agenda que o usuário está editando no momento em reação a uma ação realizada na IU, como um clique de botão.
CalendarEventActionResponseBuilderUm builder para objetos CalendarEventActionResponse.
CardUm card de contexto que representa uma única visualização na IU.
CardActionUm item de menu clicável que é adicionado ao menu de cabeçalho do cartão.
CardBuilderUm builder para objetos Card.
CardHeaderO cabeçalho de um Card.
CardSectionUma seção de cards contém grupos de widgets e oferece uma separação visual entre eles.
CardServiceCom o CardService, é possível criar cards genéricos usados em diferentes produtos de extensibilidade do Google, como os Complementos do Google Workspace.
ComposeActionResponseO objeto de resposta que pode ser retornado de um método de callback para compor ações em um complemento do Gmail.
ComposeActionResponseBuilderUm builder para objetos ComposeActionResponse.
ComposedEmailTypeUm valor de enumeração que especifica se o e-mail composto é um rascunho de resposta independente.
ContentTypeUm valor de enumeração que especifica o tipo de conteúdo do conteúdo gerado por um UpdateDraftActionResponse.
DatePickerUm campo de entrada que permite inserir uma data.
DateTimePickerUm campo de entrada que permite aos usuários inserir uma data e hora.
DecoratedTextUm widget que exibe texto com decorações opcionais.
DisplayStyleUma enumeração que define o estilo de exibição do card.
DividerUm divisor horizontal.
DriveItemsSelectedActionResponseRepresenta uma resposta que faz alterações no Drive enquanto os itens do Drive estão selecionados e em reação a uma ação realizada na IU, como um clique de botão.
DriveItemsSelectedActionResponseBuilderUm builder para objetos DriveItemsSelectedActionResponse.
EditorFileScopeActionResponseFaz mudanças em um editor, como arquivos do Documentos, do Planilhas ou do Apresentações Google em reação a uma ação realizada na IU.
EditorFileScopeActionResponseBuilderUm builder para objetos EditorFileScopeActionResponse.
FixedFooterO rodapé fixo exibido na parte inferior de um complemento Card.
GridUma grade organizada para exibir uma coleção de itens.
GridItemOs itens com que os usuários interagem em um widget de grade.
GridItemLayoutUma enumeração que define o estilo de imagem e texto de um GridItem.
HorizontalAlignmentUma enumeração que especifica o alinhamento horizontal de um widget.
IconÍcones predefinidos que podem ser usados em vários objetos da IU, como widgets ImageButton ou DecoratedText.
IconImageÉ um ícone predefinido ou um ícone de um URL com um estilo de corte personalizável.
ImageUm widget que mostra uma única imagem.
ImageButtonUma ImageButton com uma imagem exibida.
ImageComponentComponente de imagem que pode ser adicionado a itens de grade.
ImageCropStyleUma classe que representa um estilo de corte que pode ser aplicado a componentes de imagem.
ImageCropTypeUma enumeração que representa os estilos de corte aplicados aos componentes da imagem.
ImageStyleUma enumeração que define um estilo de corte de imagem.
KeyValueEsta classe foi descontinuada.
LoadIndicatorUm tipo de enumeração que especifica o tipo de carregamento ou indicador de progresso a ser exibido enquanto um Action está sendo processado.
NavigationUm objeto auxiliar que controla a navegação do card.
NotificationUma notificação exibida ao usuário como uma resposta à interação com um elemento da IU.
OnCloseUma enumeração que especifica o que fazer quando um URL aberto usando um OpenLink for fechado.
OpenAsUma enumeração que especifica como abrir um URL.
OpenLinkRepresenta uma ação para abrir um link com algumas opções.
SelectionInputUm campo de entrada que permite escolher entre um conjunto de opções predefinidas.
SelectionInputTypeTipo de entrada de seleção.
SuggestionsSugestões de preenchimento automático para complementar um widget TextInput.
SuggestionsResponseUm objeto de resposta que pode ser retornado por uma função de retorno de chamada de sugestões.
SuggestionsResponseBuilderUm builder para objetos SuggestionsResponse.
SwitchUm elemento da IU que pode ser ativado ou desativado.
SwitchControlTypeTipo de controle de widget do Switch.
TextButtonUma TextButton com uma etiqueta de texto.
TextButtonStyleUma enumeração que especifica o estilo de TextButton.
TextInputUm widget de campo de entrada que aceita entrada de texto.
TextParagraphUm widget que exibe texto e é compatível com a formatação HTML básica.
TimePickerUm campo de entrada para os usuários inserirem um horário.
UniversalActionResponseO objeto de resposta que pode ser retornado por um método que cria ações universais.
UniversalActionResponseBuilderUm builder para os objetos UniversalActionResponse.
UpdateDraftActionResponseRepresenta uma ação que atualiza o rascunho de e-mail que o usuário está editando no momento.
UpdateDraftActionResponseBuilderUm builder para objetos UpdateDraftActionResponse.
UpdateDraftBccRecipientsActionAtualiza os destinatários Cco de um rascunho de e-mail.
UpdateDraftBodyActionAtualiza o corpo do rascunho de e-mail.
UpdateDraftBodyTypeUm valor de enumeração que especifica o tipo de uma UpdateDraftBodyAction.
UpdateDraftCcRecipientsActionAtualiza os destinatários do campo "Cc" de um rascunho de e-mail.
UpdateDraftSubjectActionAtualiza a linha de assunto de um rascunho de e-mail.
UpdateDraftToRecipientsActionAtualiza os destinatários "Para" de um rascunho de e-mail.
WidgetClasse base de todos os widgets que podem ser adicionados a um Card.

Action

Métodos

MétodoTipo de retornoBreve descrição
setFunctionName(functionName)ActionDefine o nome da função de callback a ser chamada.
setLoadIndicator(loadIndicator)ActionDefine o indicador de carregamento que é exibido enquanto a ação está em andamento.
setParameters(parameters)ActionPermite que parâmetros personalizados sejam transmitidos para a função de callback.

ActionResponse

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringMostra a representação JSON desse objeto.

ActionResponseBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()ActionResponseCria a resposta de ação atual e a valida.
setNavigation(navigation)ActionResponseBuilderDefine a resposta como uma ação Navigation.
setNotification(notification)ActionResponseBuilderDefine a notificação a ser exibida quando a ação for ativada.
setOpenLink(openLink)ActionResponseBuilderDefine o URL para navegar quando a ação for ativada.
setStateChanged(stateChanged)ActionResponseBuilderDefine uma sinalização para indicar que essa ação mudou o estado de dados atual.

Attachment

Métodos

MétodoTipo de retornoBreve descrição
setIconUrl(iconUrl)AttachmentDefine o URL do ícone do anexo.
setMimeType(mimeType)AttachmentDefine o tipo MIME do anexo.
setResourceUrl(resourceUrl)AttachmentDefine o URL do recurso para o anexo.
setTitle(title)AttachmentDefine o título do anexo.

AuthorizationAction

Métodos

MétodoTipo de retornoBreve descrição
setAuthorizationUrl(authorizationUrl)AuthorizationActionDefine o URL de autorização para o qual o usuário é direcionado da solicitação de autorização.

AuthorizationException

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringMostra a representação JSON desse objeto.
setAuthorizationUrl(authUrl)AuthorizationExceptionDefine o URL de autorização para o qual o usuário é direcionado da solicitação de autorização.
setCustomUiCallback(callback)AuthorizationExceptionO nome de uma função a ser chamada para gerar uma solicitação de autorização personalizada.
setResourceDisplayName(name)AuthorizationExceptionDefine o nome que é exibido para o usuário ao solicitar a autorização.
throwException()voidAciona a exceção a ser gerada

BorderStyle

Métodos

MétodoTipo de retornoBreve descrição
setCornerRadius(radius)BorderStyleDefine o raio do canto da borda, por exemplo, 8.
setStrokeColor(color)BorderStyleDefine a cor da borda.
setType(type)BorderStyleDefine o tipo da borda.

BorderType

Propriedades

PropriedadeTipoDescrição
NO_BORDEREnumSem estilo de borda.
STROKEEnumEstilo da borda do traço.

Button

Métodos

MétodoTipo de retornoBreve descrição
setAuthorizationAction(action)ButtonDefine uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
setComposeAction(action, composedEmailType)ButtonDefine uma ação que escreve um e-mail de rascunho quando o objeto é clicado.
setOnClickAction(action)ButtonDefine uma ação que é executada quando alguém clica no objeto.
setOnClickOpenLinkAction(action)ButtonDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)ButtonDefine um URL que será aberto quando o objeto for clicado.

ButtonSet

Métodos

MétodoTipo de retornoBreve descrição
addButton(button)ButtonSetAdiciona um botão.

CalendarEventActionResponse

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringMostra a representação JSON desse objeto.

CalendarEventActionResponseBuilder

Métodos

MétodoTipo de retornoBreve descrição
addAttachments(attachments)CalendarEventActionResponseBuilderEspecifica que a resposta adicionará os anexos ao evento do Agenda quando a ação da IU associada for realizada.
addAttendees(emails)CalendarEventActionResponseBuilderEspecifica que a resposta precisa adicionar os participantes indicados ao evento do Agenda quando a ação da IU associada for realizada.
build()CalendarEventActionResponseCria a resposta de ação do evento do Agenda atual e a valida.
setConferenceData(conferenceData)CalendarEventActionResponseBuilderEspecifica que a resposta precisa definir os dados de videoconferência indicados como o evento do Agenda quando a ação de IU associada for realizada.

Card

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringMostra a representação JSON desse objeto.

CardAction

Métodos

MétodoTipo de retornoBreve descrição
setAuthorizationAction(action)CardActionDefine uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
setComposeAction(action, composedEmailType)CardActionDefine uma ação que escreve um e-mail de rascunho quando o objeto é clicado.
setOnClickAction(action)CardActionDefine uma ação que é executada quando alguém clica no objeto.
setOnClickOpenLinkAction(action)CardActionDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)CardActionDefine um URL que será aberto quando o objeto for clicado.
setText(text)CardActionDefine o texto do menu para essa ação.

CardBuilder

Métodos

MétodoTipo de retornoBreve descrição
addCardAction(cardAction)CardBuilderAdiciona um CardAction a este card.
addSection(section)CardBuilderAdiciona uma seção a este card.
build()CardCria o cartão atual e o valida.
setDisplayStyle(displayStyle)CardBuilderDefine o estilo de exibição deste card.
setFixedFooter(fixedFooter)CardBuilderDefine um rodapé fixo para este card.
setHeader(cardHeader)CardBuilderDefine o cabeçalho para este card.
setName(name)CardBuilderDefine o nome do card.
setPeekCardHeader(peekCardHeader)CardBuilderDefine o cabeçalho do card de exibição.

CardHeader

Métodos

MétodoTipo de retornoBreve descrição
setImageAltText(imageAltText)CardHeaderDefine o texto alternativo para a imagem do cabeçalho.
setImageStyle(imageStyle)CardHeaderDefine o corte do ícone no cabeçalho do cartão.
setImageUrl(imageUrl)CardHeaderDefine a imagem a ser usada no cabeçalho fornecendo o URL ou a string de dados.
setSubtitle(subtitle)CardHeaderDefine o subtítulo do cabeçalho do cartão.
setTitle(title)CardHeaderDefine o título do cabeçalho do card.

CardSection

Métodos

MétodoTipo de retornoBreve descrição
addWidget(widget)CardSectionAdiciona o widget especificado a esta seção.
setCollapsible(collapsible)CardSectionDefine se a seção pode ser recolhida.
setHeader(header)CardSectionDefine o cabeçalho da seção.
setNumUncollapsibleWidgets(numUncollapsibleWidgets)CardSectionDefine o número de widgets que ainda são mostrados quando esta seção é recolhida.

CardService

Propriedades

PropriedadeTipoDescrição
BorderTypeBorderTypeA enumeração BorderType.
ComposedEmailTypeComposedEmailTypeA enumeração ComposedEmailType.
ContentTypeContentTypeA enumeração ContentType.
GridItemLayoutGridItemLayoutA enumeração GridItemLayout.
HorizontalAlignmentHorizontalAlignmentA enumeração HorizontalAlignment.
IconIconA enumeração Icon.
ImageCropTypeImageCropTypeA enumeração ImageCropType.
ImageStyleImageStyleA enumeração ImageStyle.
LoadIndicatorLoadIndicatorA enumeração LoadIndicator.
OnCloseOnCloseA enumeração OnClose.
OpenAsOpenAsA enumeração OpenAs.
SelectionInputTypeSelectionInputTypeA enumeração SelectionInputType.
TextButtonStyleTextButtonStyleA enumeração TextButtonStyle.
UpdateDraftBodyTypeUpdateDraftBodyTypeA enumeração UpdateDraftBodyType.

Métodos

MétodoTipo de retornoBreve descrição
newAction()ActionCrie um novo Action.
newActionResponseBuilder()ActionResponseBuilderCrie um novo ActionResponseBuilder.
newAttachment()AttachmentCrie um novo Attachment.
newAuthorizationAction()AuthorizationActionCrie um novo AuthorizationAction.
newAuthorizationException()AuthorizationExceptionCrie um novo AuthorizationException.
newBorderStyle()BorderStyleCrie um novo BorderStyle.
newButtonSet()ButtonSetCrie um novo ButtonSet.
newCalendarEventActionResponseBuilder()CalendarEventActionResponseBuilderCrie um novo CalendarEventActionResponseBuilder.
newCardAction()CardActionCrie um novo CardAction.
newCardBuilder()CardBuilderCrie um novo CardBuilder.
newCardHeader()CardHeaderCrie um novo CardHeader.
newCardSection()CardSectionCrie um novo CardSection.
newComposeActionResponseBuilder()ComposeActionResponseBuilderCrie um novo ComposeActionResponseBuilder.
newDatePicker()DatePickerCrie um novo DatePicker.
newDateTimePicker()DateTimePickerCrie um novo DateTimePicker.
newDecoratedText()DecoratedTextCrie um novo DecoratedText.
newDivider()DividerCrie um novo Divider.
newDriveItemsSelectedActionResponseBuilder()DriveItemsSelectedActionResponseBuilderCrie um novo DriveItemsSelectedActionResponseBuilder.
newEditorFileScopeActionResponseBuilder()EditorFileScopeActionResponseBuilderCrie um novo EditorFileScopeActionResponseBuilder.
newFixedFooter()FixedFooterCrie um novo FixedFooter.
newGrid()GridCrie um novo Grid.
newGridItem()GridItemCrie um novo GridItem.
newIconImage()IconImageCrie um novo IconImage.
newImage()ImageCrie um novo Image.
newImageButton()ImageButtonCrie um novo ImageButton.
newImageComponent()ImageComponentCrie um novo ImageComponent.
newImageCropStyle()ImageCropStyleCrie um novo ImageCropStyle.
newKeyValue()KeyValueCrie um novo KeyValue.
newNavigation()NavigationCrie um novo Navigation.
newNotification()NotificationCrie um novo Notification.
newOpenLink()OpenLinkCrie um novo OpenLink.
newSelectionInput()SelectionInputCrie um novo SelectionInput.
newSuggestions()SuggestionsCrie um novo Suggestions.
newSuggestionsResponseBuilder()SuggestionsResponseBuilderCrie um novo SuggestionsResponseBuilder.
newSwitch()SwitchCrie um novo Switch.
newTextButton()TextButtonCrie um novo TextButton.
newTextInput()TextInputCrie um novo TextInput.
newTextParagraph()TextParagraphCrie um novo TextParagraph.
newTimePicker()TimePickerCrie um novo TimePicker.
newUniversalActionResponseBuilder()UniversalActionResponseBuilderCrie um novo UniversalActionResponseBuilder.
newUpdateDraftActionResponseBuilder()UpdateDraftActionResponseBuilderCrie um novo UpdateDraftActionResponseBuilder.
newUpdateDraftBccRecipientsAction()UpdateDraftBccRecipientsActionCria um novo UpdateDraftBccRecipientsAction.
newUpdateDraftBodyAction()UpdateDraftBodyActionCrie um novo UpdateDraftBodyAction.
newUpdateDraftCcRecipientsAction()UpdateDraftCcRecipientsActionCrie um novo UpdateDraftCcRecipientsAction.
newUpdateDraftSubjectAction()UpdateDraftSubjectActionCrie um novo UpdateDraftSubjectAction.
newUpdateDraftToRecipientsAction()UpdateDraftToRecipientsActionCrie um novo UpdateDraftToRecipientsAction.

ComposeActionResponse

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringMostra a representação JSON desse objeto.

ComposeActionResponseBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()ComposeActionResponseCria a resposta de ação de composição atual e a valida.
setGmailDraft(draft)ComposeActionResponseBuilderDefine o rascunho GmailMessage criado usando GmailMessage.createDraftReply(body) ou funções semelhantes.

ComposedEmailType

Propriedades

PropriedadeTipoDescrição
REPLY_AS_DRAFTEnumUm rascunho que é uma resposta a outra mensagem.
STANDALONE_DRAFTEnumUm rascunho que é uma mensagem independente.

ContentType

Propriedades

PropriedadeTipoDescrição
TEXTEnumIndica que o conteúdo gerado é texto simples.
MUTABLE_HTMLEnumIndica que o conteúdo gerado está formatado como HTML.
IMMUTABLE_HTMLEnumIndica que o conteúdo gerado é formatado como HTML, mas não é possível editá-lo depois de ser gerado.

DatePicker

Métodos

MétodoTipo de retornoBreve descrição
setFieldName(fieldName)DatePickerDefine o nome do campo que identifica esse seletor no objeto de evento que é gerado quando há uma interação com a IU.
setOnChangeAction(action)DatePickerDefine um Action que o script executa sempre que a entrada do seletor é alterada.
setTitle(title)DatePickerDefine o título exibido acima do campo de entrada.
setValueInMsSinceEpoch(valueMsEpoch)DatePickerDefine o valor pré-preenchido a ser definido no campo de entrada.
setValueInMsSinceEpoch(valueMsEpoch)DatePickerDefine o valor pré-preenchido a ser definido no campo de entrada.

DateTimePicker

Métodos

MétodoTipo de retornoBreve descrição
setFieldName(fieldName)DateTimePickerDefine o nome do campo que identifica esse seletor no objeto de evento que é gerado quando há uma interação com a IU.
setOnChangeAction(action)DateTimePickerDefine um Action que o script executa sempre que a entrada do seletor é alterada.
setTimeZoneOffsetInMins(timeZoneOffsetMins)DateTimePickerDefine o número de minutos em que o fuso horário deve ser ajustado em relação ao UTC.
setTitle(title)DateTimePickerDefine o título exibido acima do campo de entrada.
setValueInMsSinceEpoch(valueMsEpoch)DateTimePickerDefine o valor pré-preenchido a ser definido no campo de entrada.
setValueInMsSinceEpoch(valueMsEpoch)DateTimePickerDefine o valor pré-preenchido a ser definido no campo de entrada.

DecoratedText

Métodos

MétodoTipo de retornoBreve descrição
setAuthorizationAction(action)DecoratedTextDefine uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
setBottomLabel(text)DecoratedTextDefine o texto da etiqueta a ser usado como a chave e é exibido abaixo do conteúdo do texto.
setButton(button)DecoratedTextDefine o Button que é exibido à direita do texto.
setComposeAction(action, composedEmailType)DecoratedTextDefine uma ação que escreve um e-mail de rascunho quando o objeto é clicado.
setEndIcon(endIcon)DecoratedTextDefine o IconImage opcional que é exibido à direita do conteúdo.
setOnClickAction(action)DecoratedTextDefine uma ação que é executada quando alguém clica no objeto.
setOnClickOpenLinkAction(action)DecoratedTextDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)DecoratedTextDefine um URL que será aberto quando o objeto for clicado.
setStartIcon(startIcon)DecoratedTextDefine a IconImage opcional a ser exibida antes do conteúdo de texto.
setSwitchControl(switchToSet)DecoratedTextDefine o Switch que é exibido à direita do conteúdo.
setText(text)DecoratedTextDefine o texto a ser usado como o valor.
setTopLabel(text)DecoratedTextDefine o texto da etiqueta a ser usado como a chave e é exibido acima do conteúdo do texto.
setWrapText(wrapText)DecoratedTextDefine se o texto de valor deve ser exibido em uma única linha ou em várias linhas.

DisplayStyle

Propriedades

PropriedadeTipoDescrição
PEEKEnumMostre o cabeçalho do card na parte inferior do conteúdo complementar sobre o atual.
REPLACEEnumSubstitua o conteúdo atual para mostrar o card.

Divider

DriveItemsSelectedActionResponse

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringMostra a representação JSON desse objeto.

DriveItemsSelectedActionResponseBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()DriveItemsSelectedActionResponseCria a resposta de ação atual do Drive.
requestFileScope(itemId)DriveItemsSelectedActionResponseBuilderEspecifica o escopo do arquivo de solicitações de resposta para o item contextualmente relevante no Drive.

EditorFileScopeActionResponse

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringMostra a representação JSON desse objeto.

EditorFileScopeActionResponseBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()EditorFileScopeActionResponseCria a resposta atual da ação do editor.
requestFileScopeForActiveDocument()EditorFileScopeActionResponseBuilderSolicita o escopo drive.file para o documento ativo do Editor.

FixedFooter

Métodos

MétodoTipo de retornoBreve descrição
setPrimaryButton(button)FixedFooterDefina o botão principal no rodapé fixo.
setSecondaryButton(button)FixedFooterDefina o botão secundário no rodapé fixo.

Grid

Métodos

MétodoTipo de retornoBreve descrição
addItem(gridItem)GridAdiciona um novo item à grade.
setAuthorizationAction(action)GridDefine uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
setBorderStyle(borderStyle)GridDefine o estilo da borda aplicado a cada item da grade.
setComposeAction(action, composedEmailType)GridDefine uma ação que escreve um e-mail de rascunho quando o objeto é clicado.
setNumColumns(numColumns)GridO número de colunas a serem exibidas na grade.
setOnClickAction(action)GridDefine uma ação que é executada quando alguém clica no objeto.
setOnClickOpenLinkAction(action)GridDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)GridDefine um URL que será aberto quando o objeto for clicado.
setTitle(title)GridDefine o texto do título da grade.

GridItem

Métodos

MétodoTipo de retornoBreve descrição
setIdentifier(id)GridItemDefine o identificador para o item da grade.
setImage(image)GridItemDefine a imagem para este item da grade.
setLayout(layout)GridItemDefine o layout do texto e da imagem do item de grade.
setSubtitle(subtitle)GridItemDefine o subtítulo do item da grade.
setTextAlignment(alignment)GridItemDefine o alinhamento horizontal do item da grade.
setTitle(title)GridItemDefine o texto do título do item da grade.

GridItemLayout

Propriedades

PropriedadeTipoDescrição
TEXT_BELOWEnumO título e o subtítulo são exibidos abaixo da imagem do item da grade.
TEXT_ABOVEEnumO título e o subtítulo são mostrados acima da imagem do item da grade.

HorizontalAlignment

Propriedades

PropriedadeTipoDescrição
STARTEnumAlinhe o widget ao início do lado da frase.
CENTEREnumAlinhe o widget ao centro.
ENDEnumAlinhe o widget ao final do lado da frase.

Icon

Propriedades

PropriedadeTipoDescrição
NONEEnumNenhum ícone.
AIRPLANEEnumÍcone de avião
BOOKMARKEnumÍcone de favorito
BUSEnumÍcone de ônibus
CAREnumÍcone de carro
CLOCKEnumÍcone de relógio
CONFIRMATION_NUMBER_ICONEnumÍcone do número de confirmação
DOLLAREnumÍcone do dólar
DESCRIPTIONEnumÍcone de descrição
EMAILEnumÍcone de e-mail
EVENT_PERFORMEREnumÍcone de e-mail
EVENT_SEATEnumÍcone de evento
FLIGHT_ARRIVALEnumÍcone de chegada de voo
FLIGHT_DEPARTUREEnumÍcone de partida de voo
HOTELEnumÍcone de hotel
HOTEL_ROOM_TYPEEnumÍcone de hotel
INVITEEnumÍcone de convite
MAP_PINEnumÍcone de alfinete no mapa
MEMBERSHIPEnumÍcone de assinatura
MULTIPLE_PEOPLEEnumÍcone de várias pessoas
OFFEREnumÍcone de oferta
PERSONEnumÍcone de pessoa
PHONEEnumÍcone de telefone
RESTAURANT_ICONEnumÍcone de restaurante
SHOPPING_CARTEnumÍcone do carrinho de compras
STAREnumÍcone de estrela
STOREEnumÍcone de loja
TICKETEnumÍcone de ingresso
TRAINEnumÍcone de trem
VIDEO_CAMERAEnumÍcone de câmera de vídeo
VIDEO_PLAYEnumÍcone de reprodução de vídeo

IconImage

Métodos

MétodoTipo de retornoBreve descrição
setAltText(altText)IconImageDefine o texto alternativo do URL usado para acessibilidade.
setIcon(icon)IconImageDefine o ícone predefinido se o URL não for definido.
setIconUrl(url)IconImageDefine o URL do ícone se ele não for definido.
setImageCropType(imageCropType)IconImageDefine o estilo de corte da imagem.

Image

Métodos

MétodoTipo de retornoBreve descrição
setAltText(altText)ImageDefine o texto alternativo da imagem para acessibilidade.
setAuthorizationAction(action)ImageDefine uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
setComposeAction(action, composedEmailType)ImageDefine uma ação que escreve um e-mail de rascunho quando o objeto é clicado.
setImageUrl(url)ImageDefine a imagem a ser usada fornecendo o URL ou a string de dados.
setOnClickAction(action)ImageDefine uma ação que é executada quando alguém clica no objeto.
setOnClickOpenLinkAction(action)ImageDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)ImageDefine um URL que será aberto quando o objeto for clicado.

ImageButton

Métodos

MétodoTipo de retornoBreve descrição
setAltText(altText)ImageButtonDefine o texto alternativo do botão para acessibilidade.
setAuthorizationAction(action)ImageButtonDefine uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
setComposeAction(action, composedEmailType)ImageButtonDefine uma ação que escreve um e-mail de rascunho quando o objeto é clicado.
setIcon(icon)ImageButtonDefine um Icon predefinido para exibir no botão.
setIconUrl(url)ImageButtonDefine o URL de uma imagem a ser usada como este ícone de botão.
setOnClickAction(action)ImageButtonDefine uma ação que é executada quando alguém clica no objeto.
setOnClickOpenLinkAction(action)ImageButtonDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)ImageButtonDefine um URL que será aberto quando o objeto for clicado.

ImageComponent

Métodos

MétodoTipo de retornoBreve descrição
setAltText(altText)ImageComponentDefine o texto alternativo da imagem.
setBorderStyle(borderStyle)ImageComponentDefine o estilo da borda aplicado à imagem.
setCropStyle(imageCropStyle)ImageComponentDefine o estilo de corte da imagem.
setImageUrl(url)ImageComponentDefine o URL da imagem.

ImageCropStyle

Métodos

MétodoTipo de retornoBreve descrição
setAspectRatio(ratio)ImageCropStyleDefine a proporção a ser usada se o tipo de corte for RECTANGLE_CUSTOM.
setImageCropType(type)ImageCropStyleDefine o tipo de corte da imagem.

ImageCropType

Propriedades

PropriedadeTipoDescrição
SQUAREEnumEstilo de corte em forma quadrada.
CIRCLEEnumEstilo de corte em forma de círculo.
RECTANGLE_CUSTOMEnumEstilo de corte em forma retangular com proporção personalizada.
RECTANGLE_4_3EnumEstilo de corte em forma retangular com proporção de 4:3.

ImageStyle

Propriedades

PropriedadeTipoDescrição
SQUAREEnumSem cortes.
CIRCLEEnumCorte em formato de círculo.

KeyValue

Métodos

MétodoTipo de retornoBreve descrição
setAuthorizationAction(action)KeyValueDefine uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
setComposeAction(action, composedEmailType)KeyValueDefine uma ação que escreve um e-mail de rascunho quando o objeto é clicado.
setOnClickAction(action)KeyValueDefine uma ação que é executada quando alguém clica no objeto.
setOnClickOpenLinkAction(action)KeyValueDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)KeyValueDefine um URL que será aberto quando o objeto for clicado.

LoadIndicator

Propriedades

PropriedadeTipoDescrição
SPINNEREnumUsar um indicador giratório.
NONEEnumNão use um indicador.

Métodos

MétodoTipo de retornoBreve descrição
popCard()NavigationDestaca um cartão da pilha de navegação.
popToNamedCard(cardName)NavigationAbre o cartão especificado pelo nome dele.
popToRoot()NavigationAbre a pilha de cards para o cartão raiz.
printJson()StringMostra a representação JSON desse objeto.
pushCard(card)NavigationEnvia a placa fornecida para a pilha.
updateCard(card)NavigationFaz a substituição do cartão atual.

Notification

Métodos

MétodoTipo de retornoBreve descrição
setText(text)NotificationDefine o texto a ser exibido na notificação.

OnClose

Propriedades

PropriedadeTipoDescrição
NOTHINGEnumNão faça nada de perto.
RELOADEnumRecarrega o complemento quando a janela é fechada.

OpenAs

Propriedades

PropriedadeTipoDescrição
FULL_SIZEEnumabrir em uma janela ou guia inteira.
OVERLAYEnumAbra como uma sobreposição, como um pop-up.

Métodos

MétodoTipo de retornoBreve descrição
setOnClose(onClose)OpenLinkDefine o comportamento da ação do URL quando a janela ou a guia do URL é fechada.
setOpenAs(openAs)OpenLinkDefine o comportamento do URL quando ele é aberto.
setUrl(url)OpenLinkDefine o URL que será aberto.

SelectionInput

Métodos

MétodoTipo de retornoBreve descrição
addItem(text, value, selected)SelectionInputAdiciona um novo item que pode ser selecionado.
setFieldName(fieldName)SelectionInputDefine a chave que identifica essa entrada de seleção no objeto de evento que é gerado quando há uma interação com a IU.
setOnChangeAction(action)SelectionInputDefine um Action a ser executado sempre que a entrada de seleção mudar.
setTitle(title)SelectionInputDefine o título a ser exibido antes do campo de entrada.
setType(type)SelectionInputDefine o tipo de entrada.

SelectionInputType

Propriedades

PropriedadeTipoDescrição
CHECK_BOXEnumEstilo de entrada da caixa de seleção.
RADIO_BUTTONEnumEstilo de entrada do botão de opção para rádio.
DROPDOWNEnumEstilo de entrada da seleção do menu suspenso.

Suggestions

Métodos

MétodoTipo de retornoBreve descrição
addSuggestion(suggestion)SuggestionsAdicionar uma sugestão de texto
addSuggestions(suggestions)SuggestionsAdicione uma lista de sugestões de texto.

SuggestionsResponse

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringMostra a representação JSON desse objeto.

SuggestionsResponseBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()SuggestionsResponseCria a resposta de sugestões atual e a valida.
setSuggestions(suggestions)SuggestionsResponseBuilderDefine as sugestões usadas para o preenchimento automático nos campos de texto.

Switch

Métodos

MétodoTipo de retornoBreve descrição
setControlType(controlType)SwitchDefine o tipo de controle do interruptor.
setFieldName(fieldName)SwitchDefine a chave que identifica essa chave no objeto de evento que é gerado quando há uma interação da IU.
setOnChangeAction(action)SwitchDefine a ação a ser realizada quando o botão é alternado.
setSelected(selected)SwitchDefine se este interruptor deve ser iniciado como selecionado ou não selecionado.
setValue(value)SwitchDefine o valor que é enviado como entrada do formulário quando essa chave está ativada.

SwitchControlType

Propriedades

PropriedadeTipoDescrição
SWITCHEnumControle no estilo de um seletor de interruptor.
CHECK_BOXEnumControle no estilo da caixa de seleção de um widget de interruptor.

TextButton

Métodos

MétodoTipo de retornoBreve descrição
setAltText(altText)TextButtonDefine o texto alternativo do botão para acessibilidade.
setAuthorizationAction(action)TextButtonDefine uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
setBackgroundColor(backgroundColor)TextButtonDefine a cor do plano de fundo do botão TextButtonStyle.FILLED.
setComposeAction(action, composedEmailType)TextButtonDefine uma ação que escreve um e-mail de rascunho quando o objeto é clicado.
setDisabled(disabled)TextButtonDefine se o botão está desativado.
setOnClickAction(action)TextButtonDefine uma ação que é executada quando alguém clica no objeto.
setOnClickOpenLinkAction(action)TextButtonDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)TextButtonDefine um URL que será aberto quando o objeto for clicado.
setText(text)TextButtonDefine o texto exibido no botão.
setTextButtonStyle(textButtonStyle)TextButtonDefine o estilo do botão.

TextButtonStyle

Propriedades

PropriedadeTipoDescrição
TEXTEnumBotão de texto normal com plano de fundo claro.
FILLEDEnumBotão de texto com plano de fundo colorido.

TextInput

Métodos

MétodoTipo de retornoBreve descrição
setFieldName(fieldName)TextInputDefine a chave que identifica essa entrada de texto no objeto de evento que é gerado quando há uma interação com a IU.
setHint(hint)TextInputDefine uma dica para a entrada de texto.
setMultiline(multiline)TextInputDefine se o texto de entrada será exibido em uma ou várias linhas.
setOnChangeAction(action)TextInputDefine uma ação a ser executada sempre que a entrada de texto for alterada.
setSuggestions(suggestions)TextInputDefine as sugestões de preenchimento automático no campo de texto.
setSuggestionsAction(suggestionsAction)TextInputDefine a ação de callback para buscar sugestões com base na entrada do usuário para o preenchimento automático.
setTitle(title)TextInputDefine o título a ser exibido acima do campo de entrada.
setValue(value)TextInputDefine o valor pré-preenchido a ser definido no campo de entrada.

TextParagraph

Métodos

MétodoTipo de retornoBreve descrição
setText(text)TextParagraphDefine o texto do parágrafo.

TimePicker

Métodos

MétodoTipo de retornoBreve descrição
setFieldName(fieldName)TimePickerDefine o nome do campo que identifica esse seletor no objeto de evento que é gerado quando há uma interação com a IU.
setHours(hours)TimePickerDefine o valor pré-preenchido a ser definido no campo de entrada.
setMinutes(minutes)TimePickerDefine o valor de minutos pré-preenchido a ser definido no campo de entrada.
setOnChangeAction(action)TimePickerDefine um Action que o script executa sempre que a entrada do seletor é alterada.
setTitle(title)TimePickerDefine o título exibido acima do campo de entrada.

UniversalActionResponse

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringMostra a representação JSON desse objeto.

UniversalActionResponseBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()UniversalActionResponseCria a resposta de ação universal atual e a valida.
displayAddOnCards(cardObjects)UniversalActionResponseBuilderMostra o complemento com os cards especificados.
setOpenLink(openLink)UniversalActionResponseBuilderDefine o URL que será aberto quando a ação universal for selecionada.

UpdateDraftActionResponse

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringMostra a representação JSON desse objeto.

UpdateDraftActionResponseBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()UpdateDraftActionResponseCria a resposta de ação de rascunho de atualização atual e a valida.
setUpdateDraftBccRecipientsAction(updateDraftBccRecipientsAction)UpdateDraftActionResponseBuilderDefine uma ação que atualiza os destinatários do campo "Cco" do e-mail de um rascunho.
setUpdateDraftBodyAction(updateDraftBodyAction)UpdateDraftActionResponseBuilderDefina uma ação que atualize o corpo do e-mail de um rascunho.
setUpdateDraftCcRecipientsAction(updateDraftCcRecipientsAction)UpdateDraftActionResponseBuilderDefine uma ação que atualiza os destinatários de "Cc" de um rascunho.
setUpdateDraftSubjectAction(updateDraftSubjectAction)UpdateDraftActionResponseBuilderDefine uma ação que atualiza a linha de assunto de um rascunho.
setUpdateDraftToRecipientsAction(updateDraftToRecipientsAction)UpdateDraftActionResponseBuilderDefine uma ação que atualiza os destinatários de "Para" de um rascunho.

UpdateDraftBccRecipientsAction

Métodos

MétodoTipo de retornoBreve descrição
addUpdateBccRecipients(bccRecipientEmails)UpdateDraftBccRecipientsActionAtualiza os destinatários Cco de um rascunho de e-mail.

UpdateDraftBodyAction

Métodos

MétodoTipo de retornoBreve descrição
addUpdateContent(content, contentType)UpdateDraftBodyActionAdiciona o conteúdo especificado ao corpo do rascunho.
setUpdateType(updateType)UpdateDraftBodyActionDefine o UpdateDraftBodyType dessa ação de atualização no corpo do rascunho.

UpdateDraftBodyType

Propriedades

PropriedadeTipoDescrição
IN_PLACE_INSERTEnumPadrão:
INSERT_AT_STARTEnumAs ações de atualização inserem conteúdo no início do corpo da mensagem.
INSERT_AT_ENDEnumAs ações de atualização inserem conteúdo no final do corpo da mensagem.

UpdateDraftCcRecipientsAction

Métodos

MétodoTipo de retornoBreve descrição
addUpdateCcRecipients(ccRecipientEmails)UpdateDraftCcRecipientsActionAtualiza os destinatários do campo "Cc" de um rascunho de e-mail.

UpdateDraftSubjectAction

Métodos

MétodoTipo de retornoBreve descrição
addUpdateSubject(subject)UpdateDraftSubjectActionAtualiza a linha de assunto de um rascunho de e-mail.

UpdateDraftToRecipientsAction

Métodos

MétodoTipo de retornoBreve descrição
addUpdateToRecipients(toRecipientEmails)UpdateDraftToRecipientsActionAtualiza os destinatários "Para" de um rascunho de e-mail.

Widget