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 interface. As estruturas de interface criadas com esse serviço ficam disponíveis automaticamente em computadores e dispositivos móveis. Assim, você não precisa desenvolver interfaces separadas para ambos.

Classes

NomeBreve descrição
ActionUma ação que permite a interatividade nos elementos da interface.
ActionResponseO objeto de resposta que pode ser retornado de uma função de callback (por exemplo, um manipulador de resposta de formulário) para realizar uma ou mais ações no cliente.
ActionResponseBuilderUm builder para objetos ActionResponse.
ActionStatusUma classe que representa o status de uma solicitação para invocar ou enviar uma caixa de diálogo.
AttachmentRepresenta um anexo criado por um complemento.
AuthorizationActionUma ação de autorização que vai enviar o usuário para o AuthorizationUrl quando clicada.
AuthorizationExceptionUm erro que pode ser retornado para acionar um card de autorização a ser mostrado ao usuário.
BorderStyleUma classe que representa um estilo de borda completo que pode ser aplicado a widgets.
BorderTypeUm tipo enumerado que representa os tipos de borda que podem ser aplicados a widgets.
ButtonUma classe base para todos os botões.
ButtonSetContém um conjunto de objetos Button que são exibidos em uma linha.
CalendarEventActionResponseRepresenta uma resposta que faz alterações no evento da agenda que o usuário está editando em reação a uma ação realizada na interface, como um clique no botão.
CalendarEventActionResponseBuilderUm builder para objetos CalendarEventActionResponse.
CardUm card de contexto que representa uma única visualização na interface.
CardActionUm item de menu clicável que é adicionado ao menu do cabeçalho do cartão.
CardBuilderUm builder para objetos Card.
CardHeaderO cabeçalho de uma Card.
CardSectionUma seção de card contém grupos de widgets e oferece separação visual entre eles.
CardServiceO CardService permite criar cards genéricos usados em diferentes produtos de extensibilidade do Google, como os complementos do Google Workspace.
CardWithIdUm builder para objetos CardWithId.
CarouselO carrossel, também conhecido como controle deslizante, gira e exibe uma lista de widgets em um formato de apresentação de slides, com botões que navegam para o widget anterior ou o seguinte.
CarouselCardUm card que pode ser exibido como um item de carrossel.
ChatActionResponseUma classe que representa os parâmetros que um app de chat pode usar para configurar como a resposta é publicada.
ChatClientDataSourcePara um widget SelectionInput que usa um menu de múltipla seleção, uma fonte de dados do Google Chat.
ChatResponseO objeto de resposta para uma mensagem de card no Google Chat.
ChatResponseBuilderUm builder para objetos ChatResponse.
ChatSpaceDataSourceUma fonte de dados que preenche os espaços do Google Chat como itens de seleção para um menu de múltipla seleção.
ChipUm Chip com um ícone e um rótulo de texto.
ChipListContém um conjunto de objetos Chip que são mostrados em uma linha, sendo transferidos para a próxima linha para rolagem horizontal.
ChipListLayoutUm tipo enumerado que especifica o layout para ChipList.
CollapseControlUm controle de retração e expansão personalizável.
ColumnUma coluna.
ColumnsO widget Columns mostra até duas colunas em um card ou caixa de diálogo.
CommonDataSourceUma fonte de dados compartilhada por todos os aplicativos do Google Workspace.
ComposeActionResponseO objeto de resposta que pode ser retornado de um método de callback para a ação de composição em um complemento do Gmail.
ComposeActionResponseBuilderUm builder para objetos ComposeActionResponse.
ComposedEmailTypeUm valor de tipo enumerado que especifica se o e-mail composto é um rascunho independente ou de resposta.
ContentTypeUm valor de tipo enumerado que especifica o tipo de conteúdo gerado por um UpdateDraftActionResponse.
DatePickerUm campo de entrada que permite inserir uma data.
DateTimePickerUm campo de entrada que permite que os usuários insiram uma data e hora.
DecoratedTextUm widget que mostra texto com decorações opcionais.
DialogPara mais detalhes, consulte Abrir caixas de diálogo interativas na documentação do Google Chat.
DialogActionUm builder para objetos DialogAction.
DisplayStyleUm tipo enumerado 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 interface, como um clique no botão.
DriveItemsSelectedActionResponseBuilderUm builder para objetos DriveItemsSelectedActionResponse.
EditorFileScopeActionResponseFaz mudanças em um editor, como Documentos, Planilhas ou Apresentações Google, em reação a uma ação realizada na interface.
EditorFileScopeActionResponseBuilderUm builder para objetos EditorFileScopeActionResponse.
FixedFooterO rodapé fixo mostrado na parte de baixo de um Card.
GridUma grade organizada para mostrar uma coleção de itens.
GridItemOs itens com que os usuários interagem em um widget de grade.
GridItemLayoutUm tipo enumerado que define o estilo de imagem e texto de um GridItem.
HorizontalAlignmentUm tipo enumerado que especifica o alinhamento horizontal de um widget.
HorizontalSizeStyleUm tipo enumerado que define como os widgets preenchem o espaço de uma coluna.
HostAppDataSourcePara um widget SelectionInput que usa um menu de múltipla seleção, uma fonte de dados de um aplicativo do Google Workspace.
IconÍcones predefinidos que podem ser usados em vários objetos de interface, como widgets ImageButton ou DecoratedText.
IconImageUm ícone predefinido, um ícone do Material Design ou um ícone de um URL com um estilo de corte personalizável.
ImageUm widget que mostra uma única imagem.
ImageButtonUm ImageButton com uma imagem exibida.
ImageButtonStyleUm tipo enumerado que especifica o estilo para ImageButton.
ImageComponentUm componente de imagem que pode ser adicionado aos itens da grade.
ImageCropStyleUma classe que representa um estilo de corte que pode ser aplicado a componentes de imagem.
ImageCropTypeUm tipo enumerado que representa os estilos de corte aplicados aos componentes de imagem.
ImageStyleUm tipo enumerado que define um estilo de corte de imagem.
InputTypeUm tipo enumerado que define o tipo de entrada do widget.
InteractionUm tipo de enumeração que especifica o que fazer em resposta a uma interação com um usuário, como um usuário clicando em um botão em uma mensagem de cartão.
KeyValueEsta classe foi descontinuada.
LinkPreviewAção de card que mostra um card de visualização de link e um ícone inteligente no app host.
LoadIndicatorUm tipo de enumeração que especifica o tipo de indicador de carregamento ou de progresso a ser mostrado enquanto um Action está sendo processado.
MaterialIconUm objeto compatível com todos os ícones de fonte do Google.
NavigationUm objeto auxiliar que controla a navegação do card.
NotificationUma notificação mostrada ao usuário como uma resposta à interação com um elemento da interface.
OnCloseUm tipo enumerado que especifica o que fazer quando um URL aberto por um OpenLink é fechado.
OpenAsUm tipo enumerado que especifica como abrir um URL.
OpenLinkRepresenta uma ação para abrir um link com algumas opções.
OverflowMenuContém uma lista de objetos OverflowMenuItem que são mostrados em um menu pop-up.
OverflowMenuItemUm OverflowMenuItem com um ícone e um rótulo de texto.
PlatformDataSourcePara um widget SelectionInput que usa um menu de múltipla seleção, uma fonte de dados do Google Workspace.
ResponseTypeUm tipo enumerado que representa o tipo de resposta do app Chat.
SelectionInputUm campo de entrada que permite escolher entre um conjunto de opções predefinidas.
SelectionInputTypeO formato dos itens que os usuários podem selecionar.
StatusUm tipo enumerado que representa o código de status.
SuggestionsSugestões de preenchimento automático para complementar um widget TextInput.
SuggestionsResponseUm objeto de resposta que pode ser retornado de uma função de callback de sugestões.
SuggestionsResponseBuilderUm builder para objetos SuggestionsResponse.
SwitchUm elemento da interface que pode ser ativado ou desativado.
SwitchControlTypeTipo de controle de widget Switch.
TextButtonUm TextButton com um rótulo de texto.
TextButtonStyleUm tipo enumerado que especifica o estilo para TextButton.
TextInputUm widget de campo de entrada que aceita entrada de texto.
TextParagraphUm widget que mostra texto e oferece suporte à formatação básica de HTML.
TimePickerUm campo de entrada que permite que os usuários insiram um horário.
UniversalActionResponseO objeto de resposta que pode ser retornado de um método que cria uma ação universal.
UniversalActionResponseBuilderUm builder para os objetos UniversalActionResponse.
UpdateDraftActionResponseRepresenta uma ação que atualiza o rascunho de e-mail que o usuário está editando.
UpdateDraftActionResponseBuilderUm builder para objetos UpdateDraftActionResponse.
UpdateDraftBccRecipientsActionAtualiza os destinatários Cco de um rascunho de e-mail.
UpdateDraftBodyActionAtualiza o corpo do rascunho do e-mail.
UpdateDraftBodyTypeUm valor de tipo enumerado que especifica o tipo de um UpdateDraftBodyAction.
UpdateDraftCcRecipientsActionAtualiza os destinatários em cópia de um rascunho de e-mail.
UpdateDraftSubjectActionAtualiza a linha de assunto de um rascunho de e-mail.
UpdateDraftToRecipientsActionAtualiza os destinatários de um rascunho de e-mail.
UpdatedWidgetA resposta do widget atualizado.
ValidationUm objeto que define a regra de validação para o widget a que está anexado.
VerticalAlignmentUm tipo enumerado que define o alinhamento vertical dos widgets em uma coluna.
WidgetClasse base para todos os widgets que podem ser adicionados a um Card.
WrapStyleUm tipo enumerado que define o estilo de quebra de linha para o conteúdo em uma coluna.

Action

Métodos

MétodoTipo de retornoBreve descrição
addRequiredWidget(requiredWidget)ActionAdiciona os nomes dos widgets necessários para um envio válido.
setAllWidgetsAreRequired(allWidgetsAreRequired)ActionIndica se essa ação exige entradas de todos os widgets.
setFunctionName(functionName)ActionDefine o nome da função de callback a ser chamada.
setInteraction(interaction)ActionDefine a interação com um usuário, necessária apenas ao abrir uma caixa de diálogo.
setLoadIndicator(loadIndicator)ActionDefine o indicador de carregamento que aparece enquanto a ação está em andamento.
setParameters(parameters)ActionPermite que parâmetros personalizados sejam transmitidos para a função de callback.
setPersistValues(persistValues)ActionIndica se os valores do formulário são determinados pelos valores do cliente ou do servidor depois que uma resposta de ação atualiza o Card do formulário.

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 e valida a resposta de ação atual.
setNavigation(navigation)ActionResponseBuilderDefine a resposta a uma ação Navigation.
setNotification(notification)ActionResponseBuilderDefine a notificação para aparecer quando a ação for ativada.
setOpenLink(openLink)ActionResponseBuilderDefine o URL para navegar quando a ação é ativada.
setStateChanged(stateChanged)ActionResponseBuilderDefine uma flag para indicar que essa ação mudou o estado dos dados.

ActionStatus

Métodos

MétodoTipo de retornoBreve descrição
setStatusCode(statusCode)ActionStatusRepresenta o status de uma solicitação para abrir ou enviar uma caixa de diálogo.
setUserFacingMessage(message)ActionStatusA mensagem que será enviada aos usuários sobre o status da solicitação.

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 onde o usuário é direcionado a partir do comando 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 onde o usuário é direcionado a partir do comando 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 aparece para o usuário ao solicitar autorização.
throwException()voidAciona essa exceção.

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 compõe um e-mail de rascunho quando o objeto é clicado.
setOnClickAction(action)ButtonDefine uma ação que é executada quando o objeto é clicado.
setOnClickOpenLinkAction(action)ButtonDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)ButtonDefine um URL para ser aberto quando o objeto é clicado.
setOverflowMenu(menu)ButtonDefine um menu pop-up para ser aberto quando o objeto é 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 precisa adicionar os anexos ao evento da Agenda quando a ação da interface associada for realizada.
addAttendees(emails)CalendarEventActionResponseBuilderEspecifica que a resposta precisa adicionar os participantes indicados ao evento da Agenda quando a ação da interface associada for realizada.
build()CalendarEventActionResponseCria e valida a resposta da ação do evento da agenda atual.
setConferenceData(conferenceData)CalendarEventActionResponseBuilderEspecifica que a resposta precisa definir os dados de conferência indicados para o evento da Agenda quando a ação de interface 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 compõe um e-mail de rascunho quando o objeto é clicado.
setOnClickAction(action)CardActionDefine uma ação que é executada quando o objeto é clicado.
setOnClickOpenLinkAction(action)CardActionDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)CardActionDefine um URL para ser aberto quando o objeto é 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 e valida o cartão atual.
setDisplayStyle(displayStyle)CardBuilderDefine o estilo de exibição para este card.
setFixedFooter(fixedFooter)CardBuilderDefine um rodapé fixo para este card.
setHeader(cardHeader)CardBuilderDefine o cabeçalho do card.
setName(name)CardBuilderDefine o nome do card.
setPeekCardHeader(peekCardHeader)CardBuilderDefine o cabeçalho do card de visualizaçã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 card.
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 card.
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.
setCollapseControl(collapseControl)CardSectionDefine os botões de abertura e fechamento personalizáveis da 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 essa seção está recolhida.

CardService

Propriedades

PropriedadeTipoDescrição
BorderTypeBorderTypeA enumeração BorderType.
ChipListLayoutChipListLayoutA enumeração ChipListLayout.
ComposedEmailTypeComposedEmailTypeA enumeração ComposedEmailType.
ContentTypeContentTypeA enumeração ContentType.
GridItemLayoutGridItemLayoutA enumeração GridItemLayout.
HorizontalAlignmentHorizontalAlignmentA enumeração HorizontalAlignment.
IconIconA enumeração Icon.
ImageButtonStyleImageButtonStyleA enumeração ImageButtonStyle.
ImageCropTypeImageCropTypeA enumeração ImageCropType.
ImageStyleImageStyleA enumeração ImageStyle.
InputTypeInputTypeA enumeração InputType.
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.
newActionStatus()ActionStatusCrie um novo ActionStatus.
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()CardBuilderCria um novo criador de cards.
newCardHeader()CardHeaderCrie um novo CardHeader.
newCardSection()CardSectionCrie um novo CardSection.
newCardWithId()CardWithIdCrie um novo CardWithId.
newCarousel()CarouselCria uma Carousel.
newCarouselCard()CarouselCardCrie um novo CarouselCard.
newChatActionResponse()ChatActionResponseCrie um novo ChatActionResponse.
newChatResponseBuilder()ChatResponseBuilderCrie um novo ChatResponseBuilder.
newChip()ChipCrie um novo Chip.
newChipList()ChipListCrie um novo ChipList.
newCollapseControl()CollapseControlCrie um novo CollapseControl.
newColumn()ColumnCrie um novo Column.
newColumns()ColumnsCria um novo conjunto de Columns.
newComposeActionResponseBuilder()ComposeActionResponseBuilderCrie um novo ComposeActionResponseBuilder.
newDatePicker()DatePickerCrie um novo DatePicker.
newDateTimePicker()DateTimePickerCrie um novo DateTimePicker.
newDecoratedText()DecoratedTextCrie um novo DecoratedText.
newDialog()DialogCrie um novo Dialog.
newDialogAction()DialogActionCrie um novo DialogAction.
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.
newLinkPreview()LinkPreviewCrie um novo LinkPreview.
newMaterialIcon()MaterialIconCrie um novo MaterialIcon.
newNavigation()NavigationCrie um novo Navigation.
newNotification()NotificationCrie um novo Notification.
newOpenLink()OpenLinkCrie um novo OpenLink.
newOverflowMenu()OverflowMenuCrie um novo OverflowMenu.
newOverflowMenuItem()OverflowMenuItemCrie um novo OverflowMenuItem.
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.
newValidation()ValidationCrie um novo Validation.

CardWithId

Métodos

MétodoTipo de retornoBreve descrição
setCard(card)CardWithIdDefine o cartão do cardWithId.
setCardId(id)CardWithIdDefine o ID exclusivo do cartão da cardWithId.

Métodos

MétodoTipo de retornoBreve descrição
addCarouselCard(card)CarouselAdiciona um card de carrossel.

CarouselCard

Métodos

MétodoTipo de retornoBreve descrição
addFooterWidget(widget)CarouselCardAdiciona o widget especificado ao rodapé deste card de carrossel.
addWidget(widget)CarouselCardAdiciona o widget fornecido a este card de carrossel.

ChatActionResponse

Métodos

MétodoTipo de retornoBreve descrição
setDialogAction(dialogAction)ChatActionResponseDefine a ação da caixa de diálogo como um evento relacionado a uma caixa de diálogo.
setResponseType(responseType)ChatActionResponseO tipo de resposta do app Chat.
setUpdatedWidget(updatedWidget)ChatActionResponseDefine o widget atualizado, usado para fornecer opções de preenchimento automático para um widget.
setUrl(url)ChatActionResponseO URL para os usuários autenticarem ou configurarem.

ChatClientDataSource

Métodos

MétodoTipo de retornoBreve descrição
setSpaceDataSource(spaceDataSource)ChatClientDataSourceUma fonte de dados que preenche os espaços do Google Chat como itens de seleção para um menu de múltipla seleção.

ChatResponse

Métodos

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

ChatResponseBuilder

Métodos

MétodoTipo de retornoBreve descrição
addCardsV2(cardWithId)ChatResponseBuilderDefine o campo do cartão da mensagem.
build()ChatResponseCria e valida a resposta de ação atual.
setActionResponse(actionResponse)ChatResponseBuilderDefine o campo de resposta de ação da mensagem.
setText(text)ChatResponseBuilderDefine o texto da mensagem do Chat.

ChatSpaceDataSource

Métodos

MétodoTipo de retornoBreve descrição
setDefaultToCurrentSpace(defaultToCurrentSpace)ChatSpaceDataSourceSe definido como true, o menu de seleção múltipla seleciona o espaço atual do Google Chat como um item por padrão.

Chip

Métodos

MétodoTipo de retornoBreve descrição
setAltText(altText)ChipDefine o texto alternativo do ícone para acessibilidade.
setAuthorizationAction(action)ChipDefine uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
setComposeAction(action, composedEmailType)ChipDefine uma ação que compõe um e-mail de rascunho quando o objeto é clicado.
setDisabled(disabled)ChipDefine se o ícone está desativado.
setIcon(icon)ChipDefine o ícone a ser usado como o ícone.
setLabel(label)ChipDefine o título do ícone.
setOnClickAction(action)ChipDefine uma ação que é executada quando o objeto é clicado.
setOnClickOpenLinkAction(action)ChipDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)ChipDefine um URL para ser aberto quando o objeto é clicado.

ChipList

Métodos

MétodoTipo de retornoBreve descrição
addChip(chip)ChipListAdiciona um ícone.
setLayout(layout)ChipListDefine o layout da lista de ícones.

ChipListLayout

Propriedades

PropriedadeTipoDescrição
WRAPPEDEnumA lista de ícones vai para a próxima linha se não houver espaço horizontal suficiente.
HORIZONTAL_SCROLLABLEEnumOs ícones vão rolar horizontalmente se não couberem no espaço disponível.

CollapseControl

Métodos

MétodoTipo de retornoBreve descrição
setCollapseButton(button)CollapseControlDefine o Button que aparece para o botão "mostrar menos".
setExpandButton(button)CollapseControlDefine o Button mostrado para o botão "Mostrar mais".
setHorizontalAlign(horizontalAlignment)CollapseControlDefine o HorizontalAlignment do CollapseControl.

Column

Columns

Métodos

MétodoTipo de retornoBreve descrição
addColumn(column)ColumnsAdiciona um Column ao widget Colunas.
setWrapStyle(wrapStyle)ColumnsDefine o estilo de união das colunas e controla como elas são redimensionadas com base na largura da tela.

CommonDataSource

Propriedades

PropriedadeTipoDescrição
UNKNOWNEnumValor padrão.
USEREnumUsuários do Google Workspace.

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 e valida a resposta da ação de composição atual.
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 está formatado como HTML, mas não pode ser editado após a geração.

DatePicker

Métodos

MétodoTipo de retornoBreve descrição
setFieldName(fieldName)DatePickerDefine o nome do campo que identifica esse seletor no objeto de evento gerado quando há uma interação com a interface.
setOnChangeAction(action)DatePickerDefine uma Action que o script executa sempre que a entrada do seletor muda.
setTitle(title)DatePickerDefine o título exibido acima do campo de entrada.
setValueInMsSinceEpoch(valueMsEpoch)DatePickerDefine o valor preenchido previamente a ser definido no campo de entrada.
setValueInMsSinceEpoch(valueMsEpoch)DatePickerDefine o valor preenchido previamente 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 gerado quando há uma interação com a interface.
setOnChangeAction(action)DateTimePickerDefine uma Action que o script executa sempre que a entrada do seletor muda.
setTimeZoneOffsetInMins(timeZoneOffsetMins)DateTimePickerDefine o número de minutos que o fuso horário precisa ser compensado em relação ao UTC.
setTitle(title)DateTimePickerDefine o título exibido acima do campo de entrada.
setValueInMsSinceEpoch(valueMsEpoch)DateTimePickerDefine o valor preenchido previamente a ser definido no campo de entrada.
setValueInMsSinceEpoch(valueMsEpoch)DateTimePickerDefine o valor preenchido previamente 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 do rótulo a ser usado como chave e é exibido abaixo do conteúdo de texto.
setButton(button)DecoratedTextDefine o Button que aparece à direita do texto.
setComposeAction(action, composedEmailType)DecoratedTextDefine uma ação que compõe um e-mail de rascunho quando o objeto é clicado.
setEndIcon(endIcon)DecoratedTextDefine o IconImage opcional que aparece à direita do conteúdo.
setOnClickAction(action)DecoratedTextDefine uma ação que é executada quando o objeto é clicado.
setOnClickOpenLinkAction(action)DecoratedTextDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)DecoratedTextDefine um URL para ser aberto quando o objeto é clicado.
setStartIcon(startIcon)DecoratedTextDefine o IconImage opcional para exibição antes do conteúdo de texto.
setSwitchControl(switchToSet)DecoratedTextDefine o Switch que aparece à direita do conteúdo.
setText(text)DecoratedTextDefine o texto a ser usado como valor.
setTopLabel(text)DecoratedTextDefine o texto do rótulo a ser usado como chave e é exibido acima do conteúdo de texto.
setWrapText(wrapText)DecoratedTextDefine se o texto do valor precisa ser mostrado em uma ou várias linhas.

Dialog

Métodos

MétodoTipo de retornoBreve descrição
setBody(card)DialogDefine o cartão do Dialog.

DialogAction

Métodos

MétodoTipo de retornoBreve descrição
setActionStatus(actionStatus)DialogActionDefine o status da ação de DialogAction.
setDialog(dialog)DialogActionDefine a caixa de diálogo do DialogAction.

DisplayStyle

Propriedades

PropriedadeTipoDescrição
PEEKEnumMostre o cabeçalho do card na parte de baixo do conteúdo do complemento sobre o conteúdo existente.
REPLACEEnumMostre o card substituindo o conteúdo atual.

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 atual da ação do Drive.
requestFileScope(itemId)DriveItemsSelectedActionResponseBuilderEspecifica que a resposta solicita o escopo do arquivo para o item relevante no contexto 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 de ação do editor atual.
requestFileScopeForActiveDocument()EditorFileScopeActionResponseBuilderSolicita o escopo drive.file para o documento do editor ativo atual.

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 de borda aplicado a cada item da grade.
setComposeAction(action, composedEmailType)GridDefine uma ação que compõe 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 o objeto é clicado.
setOnClickOpenLinkAction(action)GridDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)GridDefine um URL para ser aberto quando o objeto é 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 do item da grade.
setImage(image)GridItemDefine a imagem para este item de grade.
setLayout(layout)GridItemDefine o layout de texto e imagem para o item da 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 mostrados abaixo da imagem do item da grade.
TEXT_ABOVEEnumO título e o subtítulo aparecem 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 fim do lado da frase.

HorizontalSizeStyle

Propriedades

PropriedadeTipoDescrição
FILL_AVAILABLE_SPACEEnumDefine o tamanho do Widget para preencher o espaço horizontal disponível de um Column.
FILL_MINIMUM_SPACEEnumRedimensiona o Widget para preencher a menor quantidade de espaço horizontal em um Column.

HostAppDataSource

Métodos

MétodoTipo de retornoBreve descrição
setChatDataSource(chatClientDataSource)HostAppDataSourceDefine a fonte de dados do Google Chat.

Icon

Propriedades

PropriedadeTipoDescrição
NONEEnumNenhum ícone.
AIRPLANEEnumÍcone de voo de avião
BOOKMARKEnumÍcone de favoritos
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 de cifrão
DESCRIPTIONEnumÍcone de descrição
EMAILEnumÍcone de e-mail
EVENT_PERFORMEREnumÍcone de e-mail
EVENT_SEATEnumÍcone de assento de evento
FLIGHT_ARRIVALEnumÍcone de chegada do voo
FLIGHT_DEPARTUREEnumÍcone de partida do voo
HOTELEnumÍcone de hotel
HOTEL_ROOM_TYPEEnumÍcone de hotel
INVITEEnumÍcone de convite
MAP_PINEnumÍcone de alfinete do mapa
MEMBERSHIPEnumÍcone de participação
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 da 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 estiver definido.
setIconUrl(url)IconImageDefine o URL do ícone se ele não estiver definido.
setImageCropType(imageCropType)IconImageDefine o estilo de corte da imagem.
setMaterialIcon(icon)IconImageDefine o ícone do Material Design.

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 compõe 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 o objeto é clicado.
setOnClickOpenLinkAction(action)ImageDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)ImageDefine um URL para ser aberto quando o objeto é 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 compõe um e-mail de rascunho quando o objeto é clicado.
setIcon(icon)ImageButtonDefine um Icon predefinido para exibição no botão.
setIconUrl(url)ImageButtonDefine o URL de uma imagem a ser usada como ícone do botão.
setImageButtonStyle(imageButtonStyle)ImageButtonDefine o estilo do botão.
setMaterialIcon(icon)ImageButtonDefine o ícone do Material Design.
setOnClickAction(action)ImageButtonDefine uma ação que é executada quando o objeto é clicado.
setOnClickOpenLinkAction(action)ImageButtonDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)ImageButtonDefine um URL para ser aberto quando o objeto é clicado.
setOverflowMenu(menu)ImageButtonDefine um menu pop-up para ser aberto quando o objeto é clicado.

ImageButtonStyle

Propriedades

PropriedadeTipoDescrição
BORDERLESSEnumBotão de imagem sem borda.
OUTLINEDEnumBotão de imagem com plano de fundo claro.
FILLEDEnumBotão de imagem com plano de fundo colorido.
FILLED_TONALEnumBotão de imagem com um meio-termo alternativo entre botões preenchidos e contornados.

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 de forma quadrada.
CIRCLEEnumEstilo de corte em forma de círculo.
RECTANGLE_CUSTOMEnumEstilo de corte de forma retangular com proporção personalizada.
RECTANGLE_4_3EnumEstilo de corte de forma retangular com proporção de 4:3.

ImageStyle

Propriedades

PropriedadeTipoDescrição
SQUAREEnumSem corte.
CIRCLEEnumCortar em formato de círculo.

InputType

Propriedades

PropriedadeTipoDescrição
TEXTEnumAceitar texto normal.
INTEGEREnumAceita um número inteiro.
FLOATEnumAceite um número de ponto flutuante.
EMAILEnumAceitar um endereço de e-mail.

Interaction

Propriedades

PropriedadeTipoDescrição
INTERACTION_UNSPECIFIEDEnumValor padrão.
OPEN_DIALOGEnumAbre uma caixa de diálogo, uma interface baseada em cards que os apps de chat usam para interagir com os usuários.

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 compõe um e-mail de rascunho quando o objeto é clicado.
setOnClickAction(action)KeyValueDefine uma ação que é executada quando o objeto é clicado.
setOnClickOpenLinkAction(action)KeyValueDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)KeyValueDefine um URL para ser aberto quando o objeto é clicado.

LinkPreview

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringMostra a representação JSON desse objeto.
setLinkPreviewTitle(title)LinkPreviewDefine o título que aparece na prévia do link acima do card de visualização.
setPreviewCard(previewCard)LinkPreviewDefine o card que mostra informações sobre um link de um serviço de terceiros ou de fora do Google.
setTitle(title)LinkPreviewDefine o título que aparece no ícone inteligente para a visualização do link.

LoadIndicator

Propriedades

PropriedadeTipoDescrição
SPINNEREnumUse um indicador de carregamento.
NONEEnumNão use um indicador.

MaterialIcon

Métodos

MétodoTipo de retornoBreve descrição
setFill(fill)MaterialIconIndica se o ícone é renderizado como preenchido.
setGrade(grade)MaterialIconO peso e a gradação afetam a espessura de um símbolo.
setName(name)MaterialIconDefine o nome do ícone.
setWeight(weight)MaterialIconA espessura do traço do ícone.

Métodos

MétodoTipo de retornoBreve descrição
popCard()NavigationMostra um card da pilha de navegação.
popToNamedCard(cardName)NavigationAbre o card especificado pelo nome.
popToRoot()NavigationAbre o card principal da pilha.
printJson()StringMostra a representação JSON desse objeto.
pushCard(card)NavigationEmpurre o card especificado 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 mostrado na notificação.

OnClose

Propriedades

PropriedadeTipoDescrição
NOTHINGEnumNão fazer nada ao fechar.
RELOADEnumRecarrega o complemento quando a janela é fechada.

OpenAs

Propriedades

PropriedadeTipoDescrição
FULL_SIZEEnumAbrir em uma janela ou guia inteira.
OVERLAYEnumAbrir 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 guia do URL é fechada.
setOpenAs(openAs)OpenLinkDefine o comportamento do URL quando ele é aberto.
setUrl(url)OpenLinkDefine o URL a ser aberto.

OverflowMenu

Métodos

MétodoTipo de retornoBreve descrição
addMenuItem(menuItem)OverflowMenuAdiciona um item de menu.

OverflowMenuItem

Métodos

MétodoTipo de retornoBreve descrição
setAuthorizationAction(action)OverflowMenuItemDefine uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado.
setComposeAction(action, composedEmailType)OverflowMenuItemDefine uma ação que compõe um e-mail de rascunho quando o objeto é clicado.
setDisabled(disabled)OverflowMenuItemDefine se o item de menu está desativado.
setOnClickAction(action)OverflowMenuItemDefine uma ação que é executada quando o objeto é clicado.
setOnClickOpenLinkAction(action)OverflowMenuItemDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)OverflowMenuItemDefine um URL para ser aberto quando o objeto é clicado.
setStartIcon(icon)OverflowMenuItemDefine o ícone principal do item de menu.
setText(text)OverflowMenuItemDefine o título do item de menu.

PlatformDataSource

Métodos

MétodoTipo de retornoBreve descrição
setCommonDataSource(commonDataSource)PlatformDataSourceDefine a fonte de dados do Google Workspace.
setHostAppDataSource(hostAppDataSource)PlatformDataSourceUsado para preencher espaços no menu de seleção múltipla.

ResponseType

Propriedades

PropriedadeTipoDescrição
TYPE_UNSPECIFIEDEnumTipo padrão que é processado como NEW_MESSAGE.
NEW_MESSAGEEnumPublique uma nova mensagem no tópico.
UPDATE_MESSAGEEnumAtualize a mensagem do app Chat.
UPDATE_USER_MESSAGE_CARDSEnumAtualizar os cards na mensagem de um usuário.
REQUEST_CONFIGEnumPeça ao usuário para fazer uma autenticação ou configuração extra.
DIALOGEnumApresenta uma caixa de diálogo.
UPDATE_WIDGETEnumConsulta de opções de preenchimento automático de texto do widget.

SelectionInput

Métodos

MétodoTipo de retornoBreve descrição
addItem(text, value, selected)SelectionInputAdiciona um novo item que pode ser selecionado.
addMultiSelectItem(text, value, selected, startIconUri, bottomText)SelectionInputAdiciona um novo item que pode ser selecionado para menus de várias seleções.
setExternalDataSource(action)SelectionInputDefine a fonte de dados externa, como um banco de dados relacional.
setFieldName(fieldName)SelectionInputDefine a chave que identifica essa entrada de seleção no objeto de evento gerado quando há uma interação com a interface.
setMultiSelectMaxSelectedItems(maxSelectedItems)SelectionInputDefine o número máximo de itens que um usuário pode selecionar.
setMultiSelectMinQueryLength(queryLength)SelectionInputDefine o número de caracteres de texto que um usuário digita antes que o app faça o preenchimento automático das consultas e mostre os itens sugeridos no card.
setOnChangeAction(action)SelectionInputDefine uma Action para ser executada sempre que a entrada de seleção mudar.
setPlatformDataSource(platformDataSource)SelectionInputDefine uma fonte de dados do Google Workspace.
setTitle(title)SelectionInputDefine o título a ser mostrado antes do campo de entrada.
setType(type)SelectionInputDefine o tipo dessa entrada.

SelectionInputType

Propriedades

PropriedadeTipoDescrição
CHECK_BOXEnumEstilo de entrada da caixa de seleção.
RADIO_BUTTONEnumEstilo de entrada do botão de opção.
DROPDOWNEnumEstilo de entrada de seleção do menu suspenso.
SWITCHEnumUm conjunto de interruptores.
MULTI_SELECTEnumUm menu de múltipla seleção para dados estáticos ou dinâmicos.

Status

Propriedades

PropriedadeTipoDescrição
OKEnumMapeamento HTTP: 200 OK
CANCELLEDEnumMapeamento HTTP: 499 Solicitação fechada pelo cliente
UNKNOWNEnumErro desconhecido.
INVALID_ARGUMENTEnumO cliente especificou um argumento inválido.
DEADLINE_EXCEEDEDEnumMapeamento HTTP: 504 Tempo limite do gateway
NOT_FOUNDEnumMapeamento HTTP: 404 Não encontrado
ALREADY_EXISTSEnumA entidade que um cliente tentou criar já existe.
PERMISSION_DENIEDEnumMapeamento HTTP: 403 Proibido
UNAUTHENTICATEDEnumMapeamento HTTP: 401 Não autorizado
RESOURCE_EXHAUSTEDEnumMapeamento HTTP: 429 Há muitas solicitações
FAILED_PRECONDITIONEnumA operação foi rejeitada porque o estado do sistema não é o necessário para a execução dela.
ABORTEDEnumA operação foi cancelada, normalmente devido a um problema de simultaneidade, como falha na verificação do sequenciador ou cancelamento da transação.
OUT_OF_RANGEEnumHouve uma tentativa da operação depois do intervalo válido.
UNIMPLEMENTEDEnumMapeamento HTTP: 501 Não implementado
INTERNALEnumErros internos.
UNAVAILABLEEnumMapeamento HTTP: 503 Serviço indisponível
DATA_LOSSEnumPerda ou corrupção irrecuperável de dados.

Suggestions

Métodos

MétodoTipo de retornoBreve descrição
addSuggestion(suggestion)SuggestionsAdicione 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 e valida a resposta atual das sugestões.
setSuggestions(suggestions)SuggestionsResponseBuilderDefine as sugestões usadas no 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 gerado quando há uma interação da interface.
setOnChangeAction(action)SwitchDefine a ação a ser realizada quando o interruptor for acionado.
setSelected(selected)SwitchDefine se o switch precisa começar selecionado ou não.
setValue(value)SwitchDefine o valor enviado como a entrada do formulário quando essa opção está ativada.

SwitchControlType

Propriedades

PropriedadeTipoDescrição
SWITCHEnumControle de alternância para um widget de chave.
CHECK_BOXEnumControle com estilo de caixa de seleção para um widget de chave.

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 de fundo do botão TextButtonStyle.FILLED.
setComposeAction(action, composedEmailType)TextButtonDefine uma ação que compõe um e-mail de rascunho quando o objeto é clicado.
setDisabled(disabled)TextButtonDefine se o botão está desativado.
setIcon(icon)TextButtonDefine um Icon predefinido para exibição no botão.
setIconUrl(url)TextButtonDefine o URL de uma imagem a ser usada como ícone do botão.
setMaterialIcon(icon)TextButtonDefine o ícone do Material Design.
setOnClickAction(action)TextButtonDefine uma ação que é executada quando o objeto é clicado.
setOnClickOpenLinkAction(action)TextButtonDefine uma ação que abre um URL em uma guia quando o objeto é clicado.
setOpenLink(openLink)TextButtonDefine um URL para ser aberto quando o objeto é clicado.
setOverflowMenu(menu)TextButtonDefine um menu pop-up para ser aberto quando o objeto é clicado.
setText(text)TextButtonDefine o texto que aparece no botão.
setTextButtonStyle(textButtonStyle)TextButtonDefine o estilo do botão.

TextButtonStyle

Propriedades

PropriedadeTipoDescrição
OUTLINEDEnumBotão de texto normal com plano de fundo claro.
TEXTEnumNÃO USE.
FILLEDEnumBotão de texto com plano de fundo colorido.
FILLED_TONALEnumBotão de texto normal com um meio-termo alternativo entre botões preenchidos e contornados.
BORDERLESSEnumBotão de texto normal sem borda.

TextInput

Métodos

MétodoTipo de retornoBreve descrição
setFieldName(fieldName)TextInputDefine a chave que identifica essa entrada de texto no objeto de evento gerado quando há uma interação com a interface.
setHint(hint)TextInputDefine uma dica para a entrada de texto.
setMultiline(multiline)TextInputDefine se o texto de entrada aparece em uma ou várias linhas.
setOnChangeAction(action)TextInputDefine uma ação a ser realizada sempre que a entrada de texto mudar.
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 preenchimento automático.
setTitle(title)TextInputDefine o título que será mostrado acima do campo de entrada.
setValidation(validation)TextInputDefine a regra de validação para este widget.
setValue(value)TextInputDefine o valor preenchido previamente a ser definido no campo de entrada.

TextParagraph

Métodos

MétodoTipo de retornoBreve descrição
setMaxLines(maxLines)TextParagraphDefine o número máximo de linhas de texto exibidas no widget.
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 gerado quando há uma interação com a interface.
setHours(hours)TimePickerDefine o valor das horas preenchido previamente para 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 uma Action que o script executa sempre que a entrada do seletor muda.
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 e valida a resposta atual da ação universal.
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 e valida a resposta da ação de rascunho de atualização atual.
setUpdateDraftBccRecipientsAction(updateDraftBccRecipientsAction)UpdateDraftActionResponseBuilderDefine uma ação que atualiza os destinatários Cco de um rascunho.
setUpdateDraftBodyAction(updateDraftBodyAction)UpdateDraftActionResponseBuilderDefina uma ação que atualize o corpo de um rascunho de e-mail.
setUpdateDraftCcRecipientsAction(updateDraftCcRecipientsAction)UpdateDraftActionResponseBuilderDefine uma ação que atualiza os destinatários em 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 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 desta 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 em cópia 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 de um rascunho de e-mail.

UpdatedWidget

Métodos

MétodoTipo de retornoBreve descrição
addItem(text, value, selected, startIconUri, bottomText)UpdatedWidgetAdiciona um novo item que pode ser selecionado.

Validation

Métodos

MétodoTipo de retornoBreve descrição
setCharacterLimit(characterLimit)ValidationDefine o limite de caracteres do widget.
setInputType(inputType)ValidationDefine o tipo de entrada do widget.

VerticalAlignment

Propriedades

PropriedadeTipoDescrição
CENTEREnumPosiciona verticalmente o conteúdo no centro do contêiner.
TOPEnumPosiciona verticalmente o conteúdo na parte de cima do contêiner.
BOTTOMEnumPosiciona o conteúdo verticalmente na parte de baixo do contêiner.

Widget

WrapStyle

Propriedades

PropriedadeTipoDescrição
NOWRAPEnumSem embalagem.
WRAPEnumEnvolve o conteúdo de todos os widgets em uma coluna.