Esse serviço permite que os scripts configurem e criem componentes e comportamentos de cards e widgets de uma IU. As estruturas de IU criadas com esse serviço ficam disponíveis automaticamente em computadores e dispositivos móveis. Assim, você não precisa desenvolver IUs separadas para ambos.
Aulas
Nome | Breve descrição |
---|---|
Action | Uma ação que permite interatividade nos elementos da interface. |
ActionResponse | O objeto de resposta que pode ser retornado de uma função de callback (por exemplo, um gerenciador de respostas de formulário) para executar uma ou mais ações no cliente. |
ActionResponseBuilder | Um builder para objetos ActionResponse . |
Attachment | Representa um anexo criado por um complemento. |
AuthorizationAction | Uma ação de autorização que enviará o usuário ao AuthorizationUrl quando clicado. |
AuthorizationException | Um erro que pode ser retornado para acionar um cartão de autorização a ser exibido ao usuário. |
BorderStyle | Uma classe que representa um estilo de borda completo que pode ser aplicado a widgets. |
BorderType | Um enum que representa os tipos de borda que podem ser aplicados aos widgets. |
Button | Uma classe de base para todos os botões. |
ButtonSet | Mantém um conjunto de objetos Button que são exibidos em uma linha. |
CalendarEventActionResponse | Representa uma resposta que faz alterações no evento da agenda que o usuário está editando em resposta a uma ação realizada na IU, como um clique em um botão. |
CalendarEventActionResponseBuilder | Um builder para objetos CalendarEventActionResponse . |
Card | Um card de contexto que representa uma única visualização na interface. |
CardAction | Um item de menu clicável que é adicionado ao menu do cabeçalho do cartão. |
CardBuilder | Um builder para objetos Card . |
CardHeader | O cabeçalho de uma Card . |
CardSection | Uma seção de card contém grupos de widgets e oferece uma separação visual entre eles. |
CardService | O CardService permite criar cartões genéricos usados em diferentes produtos de extensibilidade do Google, como os Complementos do Google Workspace. |
ComposeActionResponse | O objeto de resposta que pode ser retornado de um método de callback para a ação de escrever em um complemento do Gmail. |
ComposeActionResponseBuilder | Um builder para objetos ComposeActionResponse . |
ComposedEmailType | Um valor de enumeração que especifica se o e-mail escrito é um rascunho independente ou de resposta. |
ContentType | Um valor de enumeração que especifica o tipo de conteúdo gerado por um UpdateDraftActionResponse . |
DatePicker | Um campo de entrada que permite a inserção de uma data. |
DateTimePicker | Um campo de entrada que permite aos usuários inserir uma data e hora. |
DecoratedText | Um widget que mostra texto com decorações opcionais. |
DisplayStyle | Um tipo enumerado que define o estilo de exibição do cartão. |
Divider | Um divisor horizontal. |
DriveItemsSelectedActionResponse | Representa uma resposta que faz alterações no Drive enquanto os itens estão selecionados e em reação a uma ação realizada na IU, como um clique em um botão. |
DriveItemsSelectedActionResponseBuilder | Um builder para objetos DriveItemsSelectedActionResponse . |
EditorFileScopeActionResponse | Faz alterações em um editor, como o Documentos, o Planilhas ou o Apresentações Google, em reação a uma ação realizada na IU. |
EditorFileScopeActionResponseBuilder | Um builder para objetos EditorFileScopeActionResponse . |
FixedFooter | O rodapé fixo mostrado na parte de baixo de um complemento Card . |
Grid | Uma grade organizada para mostrar uma coleção de itens da grade. |
GridItem | Itens com que os usuários interagem em um widget de grade. |
GridItemLayout | Um enum que define a imagem e o estilo de texto de um GridItem. |
HorizontalAlignment | Um enum que especifica o alinhamento horizontal de um widget. |
Icon | Ícones predefinidos que podem ser usados em vários objetos da interface, como widgets ImageButton ou DecoratedText . |
IconImage | É um ícone predefinido ou de um URL com um estilo de corte personalizável. |
Image | Um widget que mostra uma única imagem. |
ImageButton | Um ImageButton com uma imagem. |
ImageComponent | É um componente de imagem que pode ser adicionado a itens de grade. |
ImageCropStyle | Uma classe que representa um estilo de corte que pode ser aplicado a componentes de imagem. |
ImageCropType | Um tipo enumerado que representa os estilos de corte aplicados aos componentes de imagem. |
ImageStyle | Um tipo enumerado que define um estilo de corte de imagem. |
| Esta classe foi descontinuada. |
LoadIndicator | Um tipo de enumeração que especifica o tipo de indicador de carregamento ou de progresso a ser exibido enquanto uma Action está sendo processada. |
Navigation | Um objeto auxiliar que controla a navegação dos cards. |
Notification | Notificação mostrada ao usuário como resposta à interação com um elemento da interface. |
OnClose | Um enum que especifica o que fazer quando um URL aberto por uma OpenLink é fechado. |
OpenAs | Um enum que especifica como abrir um URL. |
OpenLink | Representa uma ação para abrir um link com algumas opções. |
SelectionInput | Um campo de entrada que permite escolher entre um conjunto de opções predefinidas. |
SelectionInputType | Tipo de entrada de seleção. |
Suggestions | sugestões de preenchimento automático para complementar um widget TextInput . |
SuggestionsResponse | Um objeto de resposta que pode ser retornado de uma função de callback de sugestões. |
SuggestionsResponseBuilder | Um builder para objetos SuggestionsResponse . |
Switch | Um elemento da interface com suporte para ativação ou desativação. |
SwitchControlType | Tipo de um controle de widget Switch . |
TextButton | Uma TextButton com uma etiqueta de texto. |
TextButtonStyle | Um tipo enumerado que especifica o estilo de TextButton . |
TextInput | Um widget de campo de entrada que aceita entrada de texto. |
TextParagraph | Um widget que exibe texto e oferece suporte à formatação HTML básica. |
TimePicker | Campo de entrada que permite aos usuários inserir um horário. |
UniversalActionResponse | O objeto de resposta que pode ser retornado de um método que cria uma ação universal. |
UniversalActionResponseBuilder | Um builder para os objetos UniversalActionResponse . |
UpdateDraftActionResponse | Representa uma ação que atualiza o rascunho de e-mail que o usuário está editando no momento. |
UpdateDraftActionResponseBuilder | Um builder para objetos UpdateDraftActionResponse . |
UpdateDraftBccRecipientsAction | Atualiza os destinatários Cco de um rascunho de e-mail. |
UpdateDraftBodyAction | Atualiza o corpo do rascunho de e-mail. |
UpdateDraftBodyType | Um valor de enumeração que especifica o tipo de uma UpdateDraftBodyAction . |
UpdateDraftCcRecipientsAction | Atualiza os destinatários Cc de um rascunho de e-mail. |
UpdateDraftSubjectAction | Atualiza a linha de assunto de um rascunho de e-mail. |
UpdateDraftToRecipientsAction | Atualiza os destinatários em "Para" de um rascunho de e-mail. |
Widget | Classe de base para todos os widgets que podem ser adicionados a um Card . |
Action
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setFunctionName(functionName) | Action | Define o nome da função de callback a ser chamada. |
setLoadIndicator(loadIndicator) | Action | Define o indicador de carregamento mostrado enquanto a ação está em andamento. |
setParameters(parameters) | Action | Permite que parâmetros personalizados sejam transmitidos para a função de callback. |
ActionResponse
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
printJson() | String | Mostra a representação JSON desse objeto. |
ActionResponseBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
build() | ActionResponse | Cria e valida a resposta da ação atual. |
setNavigation(navigation) | ActionResponseBuilder | Define a resposta para uma ação Navigation . |
setNotification(notification) | ActionResponseBuilder | Define a notificação a ser exibida quando a ação é ativada. |
setOpenLink(openLink) | ActionResponseBuilder | Define o URL de navegação quando a ação é ativada. |
setStateChanged(stateChanged) | ActionResponseBuilder | Define uma sinalização para indicar que essa ação alterou o estado dos dados existente. |
Attachment
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setIconUrl(iconUrl) | Attachment | Define o URL do ícone do anexo. |
setMimeType(mimeType) | Attachment | Define o tipo MIME do anexo. |
setResourceUrl(resourceUrl) | Attachment | Define o URL do recurso para o anexo. |
setTitle(title) | Attachment | Define o título do anexo. |
AuthorizationAction
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setAuthorizationUrl(authorizationUrl) | AuthorizationAction | Define o URL de autorização para onde o usuário é direcionado do prompt de autorização. |
AuthorizationException
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
printJson() | String | Mostra a representação JSON desse objeto. |
setAuthorizationUrl(authUrl) | AuthorizationException | Define o URL de autorização para onde o usuário é direcionado do prompt de autorização. |
setCustomUiCallback(callback) | AuthorizationException | O nome de uma função a ser chamada para gerar um prompt de autorização personalizado. |
setResourceDisplayName(name) | AuthorizationException | Define o nome que será exibido ao usuário quando ele solicitar autorização. |
throwException() | void | Aciona o lançamento dessa exceção. |
BorderStyle
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setCornerRadius(radius) | BorderStyle | Define o raio dos cantos da borda, por exemplo, 8. |
setStrokeColor(color) | BorderStyle | Define a cor da borda. |
setType(type) | BorderStyle | Define o tipo de borda. |
BorderType
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
NO_BORDER | Enum | Nenhum estilo de borda. |
STROKE | Enum | Estilo da borda do traço. |
Button
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setAuthorizationAction(action) | Button | Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado. |
setComposeAction(action, composedEmailType) | Button | Define uma ação que compõe um rascunho de e-mail quando o objeto é clicado. |
setOnClickAction(action) | Button | Define uma ação que é executada quando o objeto é clicado. |
setOnClickOpenLinkAction(action) | Button | Define uma ação que abre um URL em uma guia quando o objeto é clicado. |
setOpenLink(openLink) | Button | Define um URL a ser aberto quando o objeto for clicado. |
ButtonSet
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addButton(button) | ButtonSet | Adiciona um botão. |
CalendarEventActionResponse
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
printJson() | String | Mostra a representação JSON desse objeto. |
CalendarEventActionResponseBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addAttachments(attachments) | CalendarEventActionResponseBuilder | Especifica que a resposta precisa adicionar os anexos ao evento do Google Agenda quando a ação de interface associada for realizada. |
addAttendees(emails) | CalendarEventActionResponseBuilder | Especifica que a resposta precisa adicionar os participantes indicados ao evento do Google Agenda quando a ação de interface associada for realizada. |
build() | CalendarEventActionResponse | Cria e valida a resposta de ação de evento atual do Google Agenda. |
setConferenceData(conferenceData) | CalendarEventActionResponseBuilder | Especifica que a resposta precisa definir os dados de videoconferência indicados para o evento do Google Agenda quando a ação de IU associada for realizada. |
Card
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
printJson() | String | Mostra a representação JSON desse objeto. |
CardAction
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setAuthorizationAction(action) | CardAction | Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado. |
setComposeAction(action, composedEmailType) | CardAction | Define uma ação que compõe um rascunho de e-mail quando o objeto é clicado. |
setOnClickAction(action) | CardAction | Define uma ação que é executada quando o objeto é clicado. |
setOnClickOpenLinkAction(action) | CardAction | Define uma ação que abre um URL em uma guia quando o objeto é clicado. |
setOpenLink(openLink) | CardAction | Define um URL a ser aberto quando o objeto for clicado. |
setText(text) | CardAction | Define o texto do menu para esta ação. |
CardBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addCardAction(cardAction) | CardBuilder | Adiciona um CardAction ao card. |
addSection(section) | CardBuilder | Adiciona uma seção ao card. |
build() | Card | Cria e valida o cartão atual. |
setDisplayStyle(displayStyle) | CardBuilder | Define o estilo de exibição do card. |
setFixedFooter(fixedFooter) | CardBuilder | Define um rodapé fixo para o card. |
setHeader(cardHeader) | CardBuilder | Define o cabeçalho do card. |
setName(name) | CardBuilder | Define o nome deste cartão. |
setPeekCardHeader(peekCardHeader) | CardBuilder | Define o cabeçalho do card de exibição. |
CardHeader
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setImageAltText(imageAltText) | CardHeader | Define o texto alternativo para a imagem do cabeçalho. |
setImageStyle(imageStyle) | CardHeader | Define o corte do ícone no cabeçalho do cartão. |
setImageUrl(imageUrl) | CardHeader | Define a imagem a ser usada no cabeçalho ao fornecer o URL ou a string de dados dela. |
setSubtitle(subtitle) | CardHeader | Define a legenda do cabeçalho do cartão. |
setTitle(title) | CardHeader | Define o título do cabeçalho do cartão. |
CardSection
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addWidget(widget) | CardSection | Adiciona o widget especificado à seção. |
setCollapsible(collapsible) | CardSection | Define se a seção pode ser recolhida. |
setHeader(header) | CardSection | Define o cabeçalho da seção. |
setNumUncollapsibleWidgets(numUncollapsibleWidgets) | CardSection | Define o número de widgets que ainda são mostrados quando a seção é recolhida. |
CardService
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
BorderType | BorderType | A enumeração BorderType . |
ComposedEmailType | ComposedEmailType | A enumeração ComposedEmailType . |
ContentType | ContentType | A enumeração ContentType . |
GridItemLayout | GridItemLayout | A enumeração GridItemLayout . |
HorizontalAlignment | HorizontalAlignment | A enumeração HorizontalAlignment . |
Icon | Icon | A enumeração Icon . |
ImageCropType | ImageCropType | A enumeração ImageCropType . |
ImageStyle | ImageStyle | A enumeração ImageStyle . |
LoadIndicator | LoadIndicator | A enumeração LoadIndicator . |
OnClose | OnClose | A enumeração OnClose . |
OpenAs | OpenAs | A enumeração OpenAs . |
SelectionInputType | SelectionInputType | A enumeração SelectionInputType . |
TextButtonStyle | TextButtonStyle | A enumeração TextButtonStyle . |
UpdateDraftBodyType | UpdateDraftBodyType | A enumeração UpdateDraftBodyType . |
Métodos
ComposeActionResponse
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
printJson() | String | Mostra a representação JSON desse objeto. |
ComposeActionResponseBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
build() | ComposeActionResponse | Cria e valida a resposta da ação de escrita atual. |
setGmailDraft(draft) | ComposeActionResponseBuilder | Define o rascunho GmailMessage criado
usando GmailMessage.createDraftReply(body) ou
funções semelhantes. |
ComposedEmailType
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
REPLY_AS_DRAFT | Enum | Um rascunho que é uma resposta a outra mensagem. |
STANDALONE_DRAFT | Enum | Um rascunho que é uma mensagem independente. |
ContentType
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
TEXT | Enum | Indica que o conteúdo gerado é um texto simples. |
MUTABLE_HTML | Enum | Indica que o conteúdo gerado está formatado como HTML. |
IMMUTABLE_HTML | Enum | Indica que o conteúdo gerado está formatado como HTML, mas ele não pode ser editado depois de gerado. |
DatePicker
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setFieldName(fieldName) | DatePicker | Define o nome do campo que identifica esse seletor no objeto de evento gerado quando há uma interação da interface. |
setOnChangeAction(action) | DatePicker | Define um Action que o script executa sempre que a entrada do seletor muda. |
setTitle(title) | DatePicker | Define o título exibido acima do campo de entrada. |
setValueInMsSinceEpoch(valueMsEpoch) | DatePicker | Define o valor preenchido automaticamente a ser definido no campo de entrada. |
setValueInMsSinceEpoch(valueMsEpoch) | DatePicker | Define o valor preenchido automaticamente a ser definido no campo de entrada. |
DateTimePicker
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setFieldName(fieldName) | DateTimePicker | Define o nome do campo que identifica esse seletor no objeto de evento gerado quando há uma interação da interface. |
setOnChangeAction(action) | DateTimePicker | Define um Action que o script executa sempre que a entrada do seletor muda. |
setTimeZoneOffsetInMins(timeZoneOffsetMins) | DateTimePicker | Define o número de minutos em que o fuso horário deve ser deslocado do UTC. |
setTitle(title) | DateTimePicker | Define o título exibido acima do campo de entrada. |
setValueInMsSinceEpoch(valueMsEpoch) | DateTimePicker | Define o valor preenchido automaticamente a ser definido no campo de entrada. |
setValueInMsSinceEpoch(valueMsEpoch) | DateTimePicker | Define o valor preenchido automaticamente a ser definido no campo de entrada. |
DecoratedText
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setAuthorizationAction(action) | DecoratedText | Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado. |
setBottomLabel(text) | DecoratedText | Define o texto do rótulo a ser usado como chave e é exibido abaixo do conteúdo do texto. |
setButton(button) | DecoratedText | Define o Button que é mostrado à direita do texto. |
setComposeAction(action, composedEmailType) | DecoratedText | Define uma ação que compõe um rascunho de e-mail quando o objeto é clicado. |
setEndIcon(endIcon) | DecoratedText | Define o IconImage opcional que é exibido à direita do conteúdo. |
setOnClickAction(action) | DecoratedText | Define uma ação que é executada quando o objeto é clicado. |
setOnClickOpenLinkAction(action) | DecoratedText | Define uma ação que abre um URL em uma guia quando o objeto é clicado. |
setOpenLink(openLink) | DecoratedText | Define um URL a ser aberto quando o objeto for clicado. |
setStartIcon(startIcon) | DecoratedText | Define a IconImage opcional que será exibida antes do conteúdo de texto. |
setSwitchControl(switchToSet) | DecoratedText | Define o Switch que é mostrado à direita do conteúdo. |
setText(text) | DecoratedText | Define o texto a ser usado como o valor. |
setTopLabel(text) | DecoratedText | Define o texto do rótulo a ser usado como chave e é exibido acima do conteúdo do texto. |
setWrapText(wrapText) | DecoratedText | Define se o texto do valor deve ser exibido em uma única linha ou em várias. |
DisplayStyle
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
PEEK | Enum | Mostre o cabeçalho do card na parte de baixo do conteúdo do complemento sobre o conteúdo atual. |
REPLACE | Enum | Substitua o conteúdo atual para mostrar o card. |
Divider
DriveItemsSelectedActionResponse
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
printJson() | String | Mostra a representação JSON desse objeto. |
DriveItemsSelectedActionResponseBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
build() | DriveItemsSelectedActionResponse | Cria a resposta atual da ação do Drive. |
requestFileScope(itemId) | DriveItemsSelectedActionResponseBuilder | Especifica o escopo do arquivo de solicitações de resposta para o item contextualmente relevante no Drive. |
EditorFileScopeActionResponse
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
printJson() | String | Mostra a representação JSON desse objeto. |
EditorFileScopeActionResponseBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
build() | EditorFileScopeActionResponse | Cria a resposta atual da ação do editor. |
requestFileScopeForActiveDocument() | EditorFileScopeActionResponseBuilder | Solicita o escopo drive.file para o documento do editor ativo atual. |
FixedFooter
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setPrimaryButton(button) | FixedFooter | Definir o botão principal no rodapé fixo. |
setSecondaryButton(button) | FixedFooter | Definir o botão secundário no rodapé fixo. |
Grid
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addItem(gridItem) | Grid | Adiciona um novo item de grade à grade. |
setAuthorizationAction(action) | Grid | Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado. |
setBorderStyle(borderStyle) | Grid | Define o estilo de borda aplicado a cada item da grade. |
setComposeAction(action, composedEmailType) | Grid | Define uma ação que compõe um rascunho de e-mail quando o objeto é clicado. |
setNumColumns(numColumns) | Grid | O número de colunas a serem exibidas na grade. |
setOnClickAction(action) | Grid | Define uma ação que é executada quando o objeto é clicado. |
setOnClickOpenLinkAction(action) | Grid | Define uma ação que abre um URL em uma guia quando o objeto é clicado. |
setOpenLink(openLink) | Grid | Define um URL a ser aberto quando o objeto for clicado. |
setTitle(title) | Grid | Define o texto do título da grade. |
GridItem
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setIdentifier(id) | GridItem | Define o identificador do item da grade. |
setImage(image) | GridItem | Define a imagem para este item da grade. |
setLayout(layout) | GridItem | Define o layout de texto e imagem para o item da grade. |
setSubtitle(subtitle) | GridItem | Define a legenda do item da grade. |
setTextAlignment(alignment) | GridItem | Define o alinhamento horizontal do item da grade. |
setTitle(title) | GridItem | Define o texto do título do item de grade. |
GridItemLayout
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
TEXT_BELOW | Enum | O título e o subtítulo são mostrados abaixo da imagem do item da grade. |
TEXT_ABOVE | Enum | O título e o subtítulo são mostrados acima da imagem do item da grade. |
HorizontalAlignment
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
START | Enum | Alinhe o widget ao início do lado da frase. |
CENTER | Enum | Alinhe o widget ao centro. |
END | Enum | Alinhe o widget ao final do lado da frase. |
Icon
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
NONE | Enum | Nenhum ícone. |
AIRPLANE | Enum | ![]() |
BOOKMARK | Enum | ![]() |
BUS | Enum | ![]() |
CAR | Enum | ![]() |
CLOCK | Enum | ![]() |
CONFIRMATION_NUMBER_ICON | Enum | ![]() |
DOLLAR | Enum | ![]() |
DESCRIPTION | Enum | ![]() |
EMAIL | Enum | ![]() |
EVENT_PERFORMER | Enum | ![]() |
EVENT_SEAT | Enum | ![]() |
FLIGHT_ARRIVAL | Enum | ![]() |
FLIGHT_DEPARTURE | Enum | ![]() |
HOTEL | Enum | ![]() |
HOTEL_ROOM_TYPE | Enum | ![]() |
INVITE | Enum | ![]() |
MAP_PIN | Enum | ![]() |
MEMBERSHIP | Enum | ![]() |
MULTIPLE_PEOPLE | Enum | ![]() |
OFFER | Enum | ![]() |
PERSON | Enum | ![]() |
PHONE | Enum | ![]() |
RESTAURANT_ICON | Enum | ![]() |
SHOPPING_CART | Enum | ![]() |
STAR | Enum | ![]() |
STORE | Enum | ![]() |
TICKET | Enum | ![]() |
TRAIN | Enum | ![]() |
VIDEO_CAMERA | Enum | ![]() |
VIDEO_PLAY | Enum | ![]() |
IconImage
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setAltText(altText) | IconImage | Define o texto alternativo do URL que é usado para acessibilidade. |
setIcon(icon) | IconImage | Define o ícone predefinido caso o URL não esteja definido. |
setIconUrl(url) | IconImage | Define o URL do ícone se ele não estiver definido. |
setImageCropType(imageCropType) | IconImage | Define o estilo de corte da imagem. |
Image
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setAltText(altText) | Image | Define o texto alternativo da imagem para acessibilidade. |
setAuthorizationAction(action) | Image | Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado. |
setComposeAction(action, composedEmailType) | Image | Define uma ação que compõe um rascunho de e-mail quando o objeto é clicado. |
setImageUrl(url) | Image | Define a imagem a ser usada fornecendo o URL ou a string de dados. |
setOnClickAction(action) | Image | Define uma ação que é executada quando o objeto é clicado. |
setOnClickOpenLinkAction(action) | Image | Define uma ação que abre um URL em uma guia quando o objeto é clicado. |
setOpenLink(openLink) | Image | Define um URL a ser aberto quando o objeto for clicado. |
ImageButton
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setAltText(altText) | ImageButton | Define o texto alternativo do botão para acessibilidade. |
setAuthorizationAction(action) | ImageButton | Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado. |
setComposeAction(action, composedEmailType) | ImageButton | Define uma ação que compõe um rascunho de e-mail quando o objeto é clicado. |
setIcon(icon) | ImageButton | Define um Icon predefinido para exibição no botão. |
setIconUrl(url) | ImageButton | Define o URL de uma imagem a ser usada como o ícone desse botão. |
setOnClickAction(action) | ImageButton | Define uma ação que é executada quando o objeto é clicado. |
setOnClickOpenLinkAction(action) | ImageButton | Define uma ação que abre um URL em uma guia quando o objeto é clicado. |
setOpenLink(openLink) | ImageButton | Define um URL a ser aberto quando o objeto for clicado. |
ImageComponent
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setAltText(altText) | ImageComponent | Define o texto alternativo da imagem. |
setBorderStyle(borderStyle) | ImageComponent | Define o estilo de borda aplicado à imagem. |
setCropStyle(imageCropStyle) | ImageComponent | Define o estilo de corte da imagem. |
setImageUrl(url) | ImageComponent | Define o URL da imagem. |
ImageCropStyle
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setAspectRatio(ratio) | ImageCropStyle | Define a proporção a ser usada se o tipo de corte for RECTANGLE_CUSTOM . |
setImageCropType(type) | ImageCropStyle | Define o tipo de corte da imagem. |
ImageCropType
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
SQUARE | Enum | Estilo de corte em formato quadrado. |
CIRCLE | Enum | Estilo de corte em forma de círculo. |
RECTANGLE_CUSTOM | Enum | Estilo de corte de forma retangular com proporção personalizada. |
RECTANGLE_4_3 | Enum | Estilo de corte em forma retangular com proporção de 4:3. |
ImageStyle
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
SQUARE | Enum | Sem recorte. |
CIRCLE | Enum | Cortar em formato de círculo. |
KeyValue
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setAuthorizationAction(action) |
| Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado. |
setComposeAction(action, composedEmailType) |
| Define uma ação que compõe um rascunho de e-mail quando o objeto é clicado. |
setOnClickAction(action) |
| Define uma ação que é executada quando o objeto é clicado. |
setOnClickOpenLinkAction(action) |
| Define uma ação que abre um URL em uma guia quando o objeto é clicado. |
setOpenLink(openLink) |
| Define um URL a ser aberto quando o objeto for clicado. |
LoadIndicator
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
SPINNER | Enum | Use um ícone de carregamento. |
NONE | Enum | Não use um indicador. |
Navigation
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
popCard() | Navigation | Aparece um card da pilha de navegação. |
popToNamedCard(cardName) | Navigation | Aparece para o cartão especificado pelo nome dele. |
popToRoot() | Navigation | Mostra a pilha de cards no cartão raiz. |
printJson() | String | Mostra a representação JSON desse objeto. |
pushCard(card) | Navigation | Envia o cartão fornecido para a pilha. |
updateCard(card) | Navigation | Faz uma substituição no local do cartão atual. |
Notification
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setText(text) | Notification | Define o texto a ser exibido na notificação. |
OnClose
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
NOTHING | Enum | Não fazer nada no fechamento. |
RELOAD | Enum | Recarrega o complemento quando a janela fecha. |
OpenAs
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
FULL_SIZE | Enum | Abrir em uma janela ou guia inteira. |
OVERLAY | Enum | Abrir como uma sobreposição, como um pop-up. |
OpenLink
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setOnClose(onClose) | OpenLink | Define o comportamento da ação do URL quando a janela ou guia do URL é fechada. |
setOpenAs(openAs) | OpenLink | Define o comportamento do URL quando ele é aberto. |
setUrl(url) | OpenLink | Define o URL que será aberto. |
SelectionInput
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addItem(text, value, selected) | SelectionInput | Adiciona um novo item que pode ser selecionado. |
setFieldName(fieldName) | SelectionInput | Define a chave que identifica essa entrada de seleção no objeto de evento gerado quando há uma interação da interface. |
setOnChangeAction(action) | SelectionInput | Define um Action a ser executado sempre que a entrada de seleção mudar. |
setTitle(title) | SelectionInput | Define o título que será exibido antes do campo de entrada. |
setType(type) | SelectionInput | Define o tipo dessa entrada. |
SelectionInputType
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
CHECK_BOX | Enum | Estilo de entrada da caixa de seleção. |
RADIO_BUTTON | Enum | Estilo de entrada do botão de opção. |
DROPDOWN | Enum | Estilo de entrada da seleção do menu suspenso. |
Suggestions
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addSuggestion(suggestion) | Suggestions | Adicione uma sugestão de texto. |
addSuggestions(suggestions) | Suggestions | Adicione uma lista de sugestões de texto. |
SuggestionsResponse
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
printJson() | String | Mostra a representação JSON desse objeto. |
SuggestionsResponseBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
build() | SuggestionsResponse | Cria e valida a resposta de sugestões atual. |
setSuggestions(suggestions) | SuggestionsResponseBuilder | Define as sugestões usadas no preenchimento automático nos campos de texto. |
Switch
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setControlType(controlType) | Switch | Define o tipo de controle do interruptor. |
setFieldName(fieldName) | Switch | Define a chave que identifica essa chave no objeto de evento gerado quando há uma interação da interface. |
setOnChangeAction(action) | Switch | Define a ação a ser realizada quando a chave for alternada. |
setSelected(selected) | Switch | Define se este switch será iniciado com ou sem seleção. |
setValue(value) | Switch | Define o valor enviado como entrada do formulário quando essa chave é ativada. |
SwitchControlType
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
SWITCH | Enum | Controle de estilo de alternância para um widget de alternância. |
CHECK_BOX | Enum | Controle no estilo caixa de seleção para um widget de chave. |
TextButton
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setAltText(altText) | TextButton | Define o texto alternativo do botão para acessibilidade. |
setAuthorizationAction(action) | TextButton | Define uma ação de autorização que abre um URL para o fluxo de autorização quando o objeto é clicado. |
setBackgroundColor(backgroundColor) | TextButton | Define a cor do plano de fundo do botão TextButtonStyle.FILLED . |
setComposeAction(action, composedEmailType) | TextButton | Define uma ação que compõe um rascunho de e-mail quando o objeto é clicado. |
setDisabled(disabled) | TextButton | Define se o botão será desativado. |
setOnClickAction(action) | TextButton | Define uma ação que é executada quando o objeto é clicado. |
setOnClickOpenLinkAction(action) | TextButton | Define uma ação que abre um URL em uma guia quando o objeto é clicado. |
setOpenLink(openLink) | TextButton | Define um URL a ser aberto quando o objeto for clicado. |
setText(text) | TextButton | Define o texto mostrado no botão. |
setTextButtonStyle(textButtonStyle) | TextButton | Define o estilo do botão. |
TextButtonStyle
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
TEXT | Enum | Botão de texto normal com plano de fundo claro. |
FILLED | Enum | Botão de texto com plano de fundo colorido. |
TextInput
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setFieldName(fieldName) | TextInput | Define a chave que identifica essa entrada de texto no objeto de evento gerado quando há uma interação da interface. |
setHint(hint) | TextInput | Define uma dica para a entrada de texto. |
setMultiline(multiline) | TextInput | Define se o texto de entrada será mostrado em uma ou várias linhas. |
setOnChangeAction(action) | TextInput | Define uma ação a ser realizada sempre que a entrada de texto for modificada. |
setSuggestions(suggestions) | TextInput | Define as sugestões de preenchimento automático no campo de texto. |
setSuggestionsAction(suggestionsAction) | TextInput | Define a ação de callback para buscar sugestões com base na entrada do usuário para preenchimento automático. |
setTitle(title) | TextInput | Define o título que será exibido acima do campo de entrada. |
setValue(value) | TextInput | Define o valor pré-preenchido a ser definido no campo de entrada. |
TextParagraph
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setText(text) | TextParagraph | Define o texto do parágrafo. |
TimePicker
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
setFieldName(fieldName) | TimePicker | Define o nome do campo que identifica esse seletor no objeto de evento gerado quando há uma interação da interface. |
setHours(hours) | TimePicker | Define o valor das horas preenchidas automaticamente a ser definido no campo de entrada. |
setMinutes(minutes) | TimePicker | Define o valor dos minutos preenchidos automaticamente a ser definido no campo de entrada. |
setOnChangeAction(action) | TimePicker | Define um Action que o script executa sempre que a entrada do seletor muda. |
setTitle(title) | TimePicker | Define o título exibido acima do campo de entrada. |
UniversalActionResponse
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
printJson() | String | Mostra a representação JSON desse objeto. |
UniversalActionResponseBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
build() | UniversalActionResponse | Cria e valida a resposta da ação universal atual. |
displayAddOnCards(cardObjects) | UniversalActionResponseBuilder | Mostra o complemento com os cards especificados. |
setOpenLink(openLink) | UniversalActionResponseBuilder | Define o URL a ser aberto quando a ação universal for selecionada. |
UpdateDraftActionResponse
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
printJson() | String | Mostra a representação JSON desse objeto. |
UpdateDraftActionResponseBuilder
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
build() | UpdateDraftActionResponse | Cria e valida a resposta da ação de rascunho da atualização atual. |
setUpdateDraftBccRecipientsAction(updateDraftBccRecipientsAction) | UpdateDraftActionResponseBuilder | Define uma ação que atualiza os destinatários Cco de um rascunho. |
setUpdateDraftBodyAction(updateDraftBodyAction) | UpdateDraftActionResponseBuilder | Defina uma ação que atualize o corpo do e-mail de um rascunho. |
setUpdateDraftCcRecipientsAction(updateDraftCcRecipientsAction) | UpdateDraftActionResponseBuilder | Define uma ação que atualiza os destinatários Cc de um rascunho. |
setUpdateDraftSubjectAction(updateDraftSubjectAction) | UpdateDraftActionResponseBuilder | Define uma ação que atualiza a linha de assunto de um rascunho. |
setUpdateDraftToRecipientsAction(updateDraftToRecipientsAction) | UpdateDraftActionResponseBuilder | Define uma ação que atualiza os destinatários de um rascunho. |
UpdateDraftBccRecipientsAction
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addUpdateBccRecipients(bccRecipientEmails) | UpdateDraftBccRecipientsAction | Atualiza os destinatários Cco de um rascunho de e-mail. |
UpdateDraftBodyAction
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addUpdateContent(content, contentType) | UpdateDraftBodyAction | Adiciona o conteúdo especificado ao corpo do rascunho. |
setUpdateType(updateType) | UpdateDraftBodyAction | Define o UpdateDraftBodyType dessa ação de atualização no corpo do rascunho. |
UpdateDraftBodyType
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
IN_PLACE_INSERT | Enum | Padrão. |
INSERT_AT_START | Enum | As ações de atualização inserem conteúdo no início do corpo da mensagem. |
INSERT_AT_END | Enum | As ações de atualização inserem conteúdo no final do corpo da mensagem. |
UpdateDraftCcRecipientsAction
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addUpdateCcRecipients(ccRecipientEmails) | UpdateDraftCcRecipientsAction | Atualiza os destinatários Cc de um rascunho de e-mail. |
UpdateDraftSubjectAction
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addUpdateSubject(subject) | UpdateDraftSubjectAction | Atualiza a linha de assunto de um rascunho de e-mail. |
UpdateDraftToRecipientsAction
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addUpdateToRecipients(toRecipientEmails) | UpdateDraftToRecipientsAction | Atualiza os destinatários em "Para" de um rascunho de e-mail. |