AddOns Response Service

Adicionar o serviço de resposta decomplementos

Esse serviço permite que os scripts configurem e criem complementos do Google Workspace.

Classes

NomeBreve descrição
AccessoryWidget
ActionUma ação que os complementos do Google Workspace que estendem o Workspace Studio podem usar para renderizar um novo card.
ActionResponse
ActionResponseBuilder
AddOnsResponseServiceO AddOnsResponseService permite criar respostas para complementos do Google Workspace.
AddonComposeUiActionResponse
AddonComposeUiActionResponseBuilder
AddonComposeUiActionType
Attachment
BasicDataTypeUma enumeração que representa os tipos de dados genéricos básicos.
CalendarEventActionResponse
CalendarEventActionResponseBuilder
ChatDataActionsResponseBuilder
ChatMessage
ColorUm objeto Color que representa uma cor no espaço de cores RGBA.
ComposeActionResponse
ComposeActionResponseBuilder
ComposedEmailType
ContentType
CreateMessageAction
DataActionsResponse
DataTypeUm DataType é usado para definir o tipo de uma variável.
DriveItemsSelectedActionResponse
DriveItemsSelectedActionResponseBuilder
DynamicResourceDefinitionUma DynamicResourceDefinition é um bloco de construção para um ResourceFieldsDefinitionRetrievedAction. Ela pode conter um ou mais números de ResourceField para definir dinamicamente o número de variáveis de saída fornecidas por uma etapa no Google Workspace Studio.
EditorFileScopeActionResponse
EditorFileScopeActionResponseBuilder
EndNavigation
ErrorActionabilityUm enum que representa a capacidade de ação do erro.
ErrorRetryabilityUma enumeração que representa a capacidade de repetição da invocação de ação quando há um erro.
FontWeightUma enumeração que representa a espessura da fonte do texto estilizado.
HostAppActionUma HostAppAction é um tipo de ação processada por apps host individuais.
HyperlinkUm elemento de hiperlink usado em TextFormatElement.
InsertSectionUm builder para objetos InsertSection.
InsertWidgetUm builder para objetos InsertWidget.
LinkO objeto de link de um recurso de terceiros que é convertido em um ícone inteligente no aplicativo host.
LinkPreview
ListContainerContêiner para itens de lista, em que cada item pode conter vários TextFormatElement.
ListItemUm item de lista, em que cada item pode conter vários TextFormatElement.
ListTypeUma enumeração que representa o tipo da lista.
ModifyCardUm criador de objetos ModifyCard que muda e atualiza a interface de um card existente transmitindo o objeto ModifyCard para um Action.
NavigationUm objeto auxiliar que controla a navegação por cards.
Notification
OnClose
OpenAs
OpenLink
RemoveSectionUm builder para objetos RemoveSection.
RemoveWidgetUm builder para objetos RemoveWidget.
RenderActionRenderiza ou atualiza um card realizando um Action em resposta a uma interação do usuário.
RenderActionBuilderUm builder para objetos RenderAction.
ResourceDataRepresenta dados de recursos específicos de um aplicativo. Os dados de recursos contêm uma coleção de pares de chave-valor de nomes de variáveis e VariableData.
ResourceFieldUm ResourceField é um bloco de construção básico de um DynamicResourceDefinition. Cada campo de recurso corresponde a uma variável de saída da etapa atual.
ResourceFieldsDefinitionRetrievedActionUm ResourceFieldsDefinitionRetrievedAction é um tipo de ResourceFieldsDefinitionRetrievedAction usado para recuperar a definição de uma lista de campos de recursos usando a função dynamicResourceDefinitionProvider especificada no manifesto.
ResourceRetrievedActionUma ResourceRetrievedAction é usada para recuperar o conteúdo de recursos personalizados quando necessário, em que o campo de recurso personalizado é definido no ResourceData.
ResourceTypeUm tipo de recurso específico do aplicativo. O identificador exclusivo do tipo de recurso precisa ter uma WorkflowResourceDefinition correspondente.
ReturnElementErrorActionUm ReturnElementErrorAction indica que ocorreu um erro durante a invocação do elemento.
ReturnOutputVariablesActionContém variáveis de saída geradas pela ação executada no Google Workspace Studio.
SaveWorkflowActionEssa ação indica que o app host (Google Workspace Studio) precisa salvar o agente.
SendStatus
StyledTextElemento de texto com estilos como negrito, itálico e cor.
TextFormatChipUm ícone clicável no formato de texto.
TextFormatElementUm elemento de formato de texto, que pode ser TextFormatChip, StyledText, Hyperlink ou ListContainer.
TextFormatIconUm ícone exibido em um TextFormatChip.
TextStyleUma enumeração que representa o estilo do texto estilizado.
TimeStampRepresenta um objeto de carimbo de data/hora que pode ser adicionado a um VariableData.
UniversalActionResponse
UniversalActionResponseBuilder
UpdateDraftActionResponse
UpdateDraftActionResponseBuilder
UpdateDraftBccRecipientsAction
UpdateDraftBodyAction
UpdateDraftBodyType
UpdateDraftCcRecipientsAction
UpdateDraftSubjectAction
UpdateDraftToRecipientsAction
UpdateInlinePreviewAction
UpdateMessageAction
UpdateWidgetUm builder para objetos UpdateWidget.
ValidationErrorSeverityUma enumeração que representa a gravidade do erro de validação.
ValueMetadataUm valueMetadata contém informações sobre os valores possíveis de uma variável.
VariableDataRepresenta um dado variável que pode conter uma coleção de valores em vários tipos.
WorkflowActionUm WorkflowAction é um tipo de HostAppAction usado para realizar uma ação específica no Google Workspace Studio.
WorkflowTextFormatUm bloco de texto com opções de formatação avançada, incluindo estilos, hiperlinks e elementos interativos definidos em TextFormatElement.
WorkflowValidationErrorActionEssa ação indica que o app host (Google Workspace Studio) precisa mostrar um erro de validação.

AccessoryWidget

Métodos

MétodoTipo de retornoBreve descrição
addWidget(widget)AccessoryWidgetDefine o widget para esta ação.

Action

Métodos

MétodoTipo de retornoBreve descrição
addModifyCard(modifyCard)ActionAdiciona uma operação ModifyCard à ação.
addNavigation(navigation)ActionAdiciona uma navegação por cards à ação.

ActionResponse

Métodos

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

ActionResponseBuilder

Métodos

MétodoTipo de retornoBreve descrição
addModifyCard(modifyCard)ActionResponseBuilderDefine a operação de modificação do card para a ação.
build()ActionResponseCria e valida a resposta da ação atual.
setLinkPreview(linkPreview)ActionResponseBuilderDefine o LinkPreview para a ação.
setNavigation(navigation)ActionResponseBuilderDefine a resposta para uma ação Navigation.
setNotification(notification)ActionResponseBuilderDefine a notificação a ser exibida quando a ação é 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 atuais.

AddOnsResponseService

Propriedades

PropriedadeTipoDescrição
AddonComposeUiActionTypeAddonComposeUiActionTypeA enumeração AddonComposeUiActionType.
ComposedEmailTypeComposedEmailTypeA enumeração ComposedEmailType.
ContentTypeContentTypeA enumeração ContentType.
EndNavigationEndNavigationA enumeração EndNavigation.
OnCloseOnCloseA enumeração OnClose.
OpenAsOpenAsA enumeração OpenAs.
SendStatusSendStatusA enumeração SendStatus.
UpdateDraftBodyTypeUpdateDraftBodyTypeA enumeração UpdateDraftBodyType.

Métodos

MétodoTipo de retornoBreve descrição
newAccessoryWidget()AccessoryWidgetCrie um novo AccessoryWidget.
newAction()ActionCrie um novo Action.
newActionResponseBuilder()ActionResponseBuilderCria uma ActionResponseBuilder.
newAddonComposeUiActionResponseBuilder()AddonComposeUiActionResponseBuilderCria uma AddonComposeUiActionResponseBuilder.
newAttachment()AttachmentCria uma Attachment.
newCalendarEventActionResponseBuilder()CalendarEventActionResponseBuilderCria uma CalendarEventActionResponseBuilder.
newChatDataActionBuilder()ChatDataActionsResponseBuilderCria uma ChatDataActionsResponseBuilder.
newChatMessage()ChatMessageCria uma ChatMessage.
newComposeActionResponseBuilder()ComposeActionResponseBuilderCria uma ComposeActionResponseBuilder.
newCreateMessageAction()CreateMessageActionCria uma CreateMessageAction.
newDriveItemsSelectedActionResponseBuilder()DriveItemsSelectedActionResponseBuilderCria uma DriveItemsSelectedActionResponseBuilder.
newEditorFileScopeActionResponseBuilder()EditorFileScopeActionResponseBuilderCria uma EditorFileScopeActionResponseBuilder.
newLinkPreview()LinkPreviewCria uma LinkPreview.
newNavigation()NavigationCria uma Navigation.
newNotification()NotificationCria uma Notification.
newOpenLink()OpenLinkCria uma OpenLink.
newRenderActionBuilder()RenderActionBuilderCrie um novo RenderActionBuilder.
newUniversalActionResponseBuilder()UniversalActionResponseBuilderCria uma UniversalActionResponseBuilder.
newUpdateDraftActionResponseBuilder()UpdateDraftActionResponseBuilderCria uma UpdateDraftActionResponseBuilder.
newUpdateDraftBccRecipientsAction()UpdateDraftBccRecipientsActionCria um UpdateDraftBccRecipientsAction;
newUpdateDraftBodyAction()UpdateDraftBodyActionCria uma UpdateDraftBodyAction.
newUpdateDraftCcRecipientsAction()UpdateDraftCcRecipientsActionCria uma UpdateDraftCcRecipientsAction.
newUpdateDraftSubjectAction()UpdateDraftSubjectActionCria uma UpdateDraftSubjectAction.
newUpdateDraftToRecipientsAction()UpdateDraftToRecipientsActionCria uma UpdateDraftToRecipientsAction.
newUpdateInlinePreviewAction()UpdateInlinePreviewActionCria uma UpdateInlinePreviewAction.
newUpdateMessageAction()UpdateMessageActionCria uma UpdateMessageAction.

AddonComposeUiActionResponse

Métodos

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

AddonComposeUiActionResponseBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()AddonComposeUiActionResponseCria e valida a resposta da ação da interface do usuário de composição do complemento atual.
setType(type)AddonComposeUiActionResponseBuilderDefine o campo de enumeração que determina a ação da interface do usuário de composição do complemento.

AddonComposeUiActionType

Propriedades

PropriedadeTipoDescrição
DISMISSEnumPadrã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.

BasicDataType

Propriedades

PropriedadeTipoDescrição
BASIC_TYPE_UNSPECIFIEDEnumValor padrão.
STRINGEnumUma string de caracteres.
INTEGEREnumUm valor inteiro.
FLOATEnumUm número de ponto flutuante.
TIMESTAMPEnumUm carimbo de data/hora no formato ISO 8601.
BOOLEANEnumUm valor booleano.
EMAIL_ADDRESSEnumUma string no formato de um endereço de e-mail.
GOOGLE_USEREnumUm usuário dos Serviços do Google, no formato "users/encoded_GAIA_ID"
FILEEnumUm tipo de arquivo.
FORMATTED_TEXTEnumUm texto com formatação avançada.

CalendarEventActionResponse

Métodos

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

CalendarEventActionResponseBuilder

Métodos

MétodoTipo de retornoBreve descrição
addAttachments(attachments)CalendarEventActionResponseBuilderEspecifica que a resposta deve adicionar os anexos ao evento da Agenda quando a ação da interface associada for realizada.
addAttendees(emails)CalendarEventActionResponseBuilderEspecifica que a resposta deve 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 deve definir os dados de conferência indicados para o evento da Agenda quando a ação de interface associada for realizada.

ChatDataActionsResponseBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()DataActionsResponseCria a resposta da ação atual.
setCreateChatMessageAction(createMessageAction)ChatDataActionsResponseBuilderDefine o CreateMessageAction para este DataActionsResponse.
setUpdateChatMessageAction(updateMessageAction)ChatDataActionsResponseBuilderDefine o UpdateMessageAction para este DataActionsResponse.
setUpdateInlinePreviewAction(updateInlinePreviewAction)ChatDataActionsResponseBuilderDefine o UpdateInlinePreviewAction para este DataActionsResponse.

ChatMessage

Métodos

MétodoTipo de retornoBreve descrição
addCardWithId(cardWithId)ChatMessageDefine o card da mensagem.
setText(text)ChatMessageDefine o texto da mensagem.

Color

Métodos

MétodoTipo de retornoBreve descrição
setAlpha(alpha)ColorDefine o componente alfa da cor.
setBlue(blue)ColorDefine o componente azul da cor.
setGreen(green)ColorDefine o componente verde da cor.
setRed(red)ColorDefine o componente vermelho da cor.

ComposeActionResponse

Métodos

MétodoTipo de retornoBreve descrição
printJson()StringImprime a representação JSON deste 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 depois de gerado.

CreateMessageAction

Métodos

MétodoTipo de retornoBreve descrição
setMessage(message)CreateMessageActionDefine a mensagem para essa ação.

DataActionsResponse

Métodos

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

DataType

Métodos

MétodoTipo de retornoBreve descrição
setBasicDataType(basicDataType)DataTypeDefine o tipo de dados como um dos BasicDataTypes compatíveis.
setResourceType(resourceType)DataTypeDefine o tipo de dados como um ResourceType definido pelo usuário.
setValueMetadata(valueMetadata)DataTypeDefine o ValueMetadata, que contém informações relacionadas ao tipo da variável.

DriveItemsSelectedActionResponse

Métodos

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

DriveItemsSelectedActionResponseBuilder

Métodos

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

DynamicResourceDefinition

Métodos

MétodoTipo de retornoBreve descrição
addResourceField(resourceField)DynamicResourceDefinitionAdiciona um campo de recurso à definição de recurso dinâmico.
setResourceId(resourceId)DynamicResourceDefinitionDefine o ID da definição de recurso dinâmico, que corresponde ao workflowResourceDefinitionId no manifesto.

EditorFileScopeActionResponse

Métodos

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

EditorFileScopeActionResponseBuilder

Métodos

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

EndNavigation

Propriedades

PropriedadeTipoDescrição
ACTION_UNSPECIFIEDEnumAção não especificada.
CLOSE_DIALOGEnumFecha uma caixa de diálogo.
CLOSE_DIALOG_AND_EXECUTEEnumFecha uma caixa de diálogo e atualiza o card que a abriu.

ErrorActionability

Propriedades

PropriedadeTipoDescrição
ERROR_ACTIONABILITY_UNSPECIFIEDEnumNão especificado.
NOT_ACTIONABLEEnumO erro não pode ser corrigido pelo usuário no card de configuração.
ACTIONABLEEnumO erro pode ser corrigido pelo usuário no card de configuração.

ErrorRetryability

Propriedades

PropriedadeTipoDescrição
RETRYABILITY_UNSPECIFIEDEnumNão especificado.
NOT_RETRYABLEEnumO erro não pode ser repetido, e o fluxo termina após a primeira tentativa.
RETRYABLEEnumO erro é passível de novas tentativas, e o fluxo de trabalho vai tentar executar a etapa até cinco vezes.

FontWeight

Propriedades

PropriedadeTipoDescrição
FONT_WEIGHT_UNSPECIFIEDEnumPeso padrão com espessura normal.
LIGHTEnumMais leve e com espessura reduzida.
MEDIUMEnumPeso intermediário entre leve e negrito.
BOLDEnumMais pesado e com maior espessura.

HostAppAction

Métodos

MétodoTipo de retornoBreve descrição
setWorkflowAction(workflowAction)HostAppActionDefine a ação do app host como ação do fluxo de trabalho.

Métodos

MétodoTipo de retornoBreve descrição
setLink(link)HyperlinkDefine o URL de destino do hiperlink.
setText(text)HyperlinkDefine o texto do hiperlink.

InsertSection

Métodos

MétodoTipo de retornoBreve descrição
insertAtTop(onCardTop)InsertSectionDefine a flag onCardTop, que indica se a nova seção deve ser inserida na parte de cima do card.
insertBelowSection(sectionId)InsertSectionDefine o ID da seção, e a nova seção é inserida abaixo dela.
setSection(section)InsertSectionDefine a seção do card a ser inserida.

InsertWidget

Métodos

MétodoTipo de retornoBreve descrição
insertAboveWidget(widgetId)InsertWidgetDefine o ID do widget, e o novo widget é inserido acima do widget com o ID especificado.
insertBelowWidget(widgetId)InsertWidgetDefine o ID do widget, e o novo widget é inserido abaixo do widget com o ID especificado.
setWidget(widget)InsertWidgetDefine o Widget a ser inserido.

Métodos

MétodoTipo de retornoBreve descrição
setTitle(title)LinkDefine o título do link.
setUrl(url)LinkDefine o URL do link.

LinkPreview

Métodos

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

ListContainer

Métodos

MétodoTipo de retornoBreve descrição
addListItem(listItem)ListContainerAdiciona um item de lista ao contêiner de lista.
setListNestLevel(listLevel)ListContainerDefine o nível da lista, começando em 0 para o nível superior e aumentando em 1 para cada lista aninhada.
setListType(listType)ListContainerDefine o tipo da lista como ordenada ou não ordenada.

ListItem

Métodos

MétodoTipo de retornoBreve descrição
addTextFormatElement(textFormatElement)ListItemAdiciona um TextFormatElement ao item da lista.

ListType

Propriedades

PropriedadeTipoDescrição
LIST_TYPE_UNSPECIFIEDEnumValor padrão.
ORDEREDEnumLista ordenada.
UNORDEREDEnumLista não ordenada.

ModifyCard

Métodos

MétodoTipo de retornoBreve descrição
setInsertSection(insertSection)ModifyCardDefine o InsertSection para este objeto de cartão de modificação.
setInsertWidget(insertWidget)ModifyCardDefine o InsertWidget para este objeto de cartão de modificação.
setRemoveSection(removeSection)ModifyCardDefine o RemoveSection para este objeto de cartão de modificação.
setRemoveWidget(removeWidget)ModifyCardDefine o RemoveWidget para este objeto de cartão de modificação.
setReplaceSection(replacementSection)ModifyCardDefine a CardSection de substituição para este objeto de cartão de modificação. A seção de substituição precisa ter o mesmo ID de uma seção de cartão existente.
setReplaceWidget(replacementWidget)ModifyCardDefine o widget de substituição para este objeto de cartão de modificação. O widget de substituição precisa ter o mesmo ID de um widget atual.
setUpdateWidget(updateWidget)ModifyCardDefine o UpdateWidget para este objeto de cartão de modificação.

Métodos

MétodoTipo de retornoBreve descrição
popCard()Navigation
popToNamedCard(cardName)Navigation
popToRoot()Navigation
printJson()StringImprime a representação JSON deste objeto.
pushCard(card)NavigationEnvia o card especificado para a pilha.
setEndNavigation(endNavigation)NavigationDefine a ação de navegação final.
updateCard(card)NavigationFaz uma substituição no lugar 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_SIZEEnumAbra em uma janela ou guia completa.
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 de 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.

RemoveSection

Métodos

MétodoTipo de retornoBreve descrição
setSectionId(sectionId)RemoveSectionDefine o ID da seção a ser removida.

RemoveWidget

Métodos

MétodoTipo de retornoBreve descrição
setWidgetId(widgetId)RemoveWidgetDefine o ID do widget a ser removido.

RenderAction

Métodos

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

RenderActionBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()RenderActionCria e valida a ação de renderização atual.
setAction(action)RenderActionBuilderDefine a ação que os complementos podem usar para atualizar a interface do usuário para a ação de renderização.
setHostAppAction(hostAppAction)RenderActionBuilderDefine o HostAppAction processado por apps host individuais para a ação de renderização.

ResourceData

Métodos

MétodoTipo de retornoBreve descrição
addVariableData(key, value)ResourceDataAdiciona um VariableData com chave pelo nome da variável. Um valor é substituído se a chave já existir.
setVariableDataMap(fields)ResourceDataDefine o mapa dos dados da variável com chave pelos nomes das variáveis.

ResourceField

Métodos

MétodoTipo de retornoBreve descrição
setDataType(dataType)ResourceFieldDefine o tipo de dados do campo e permite que outras etapas filtrem as variáveis por tipo na seleção.
setDisplayText(displayText)ResourceFieldDefine a descrição do campo que é mostrada ao usuário final durante a seleção de variáveis em etapas subsequentes.
setSelector(selector)ResourceFieldDefine uma chave para que a função do provedor forneça o valor durante a execução da etapa.

ResourceFieldsDefinitionRetrievedAction

Métodos

MétodoTipo de retornoBreve descrição
addDynamicResourceDefinition(dynamicResourceDefinition)ResourceFieldsDefinitionRetrievedActionAdiciona um DynamicResourceDefinition à ação de recuperação da definição dos campos de recursos.

ResourceRetrievedAction

Métodos

MétodoTipo de retornoBreve descrição
setResourceData(resourceData)ResourceRetrievedActionDefine o ResourceData como a ação de recuperação de recursos para fornecer valores aos campos de recursos dinâmicos ou personalizados.

ResourceType

Métodos

MétodoTipo de retornoBreve descrição
setWorkflowResourceDefinitionId(resourceType)ResourceTypeDefine o ID da definição do recurso de fluxo de trabalho.

ReturnElementErrorAction

Métodos

MétodoTipo de retornoBreve descrição
setErrorActionability(errorActionability)ReturnElementErrorActionDefine a capacidade de ação do erro. Um erro é acionável se puder ser resolvido reconfigurando a etapa.
setErrorLog(log)ReturnElementErrorActionDefine o registro de erros a ser mostrado ao usuário final no feed de atividades do fluxo de trabalho.
setErrorRetryability(errorRetryability)ReturnElementErrorActionDefine a capacidade de repetição de erros. O fluxo termina após a primeira tentativa se um erro não for repetível.

ReturnOutputVariablesAction

Métodos

MétodoTipo de retornoBreve descrição
addVariableData(key, value)ReturnOutputVariablesActionAdiciona dados de variável com chave pelo nome da variável. Um valor é substituído se a chave já existir.
setLog(log)ReturnOutputVariablesActionDefine o registro da ação de fluxo de trabalho executada para o usuário final no feed de atividades do fluxo de trabalho.
setVariableDataMap(variables)ReturnOutputVariablesActionDefine o mapa dos dados da variável indexados pelo nome da variável. Um valor é substituído se a chave já existir.

SaveWorkflowAction

SendStatus

Propriedades

PropriedadeTipoDescrição
NOT_SENDEnumPadrão.
CONTINUE_SENDEnumContinue enviando o e-mail depois de atualizar o rascunho.

StyledText

Métodos

MétodoTipo de retornoBreve descrição
addStyle(style)StyledTextDefine o estilo do texto estilizado e pode aplicar vários estilos a um único texto estilizado.
setColor(color)StyledTextDefine a cor do texto estilizado.
setFontWeight(fontWeight)StyledTextDefine a espessura da fonte do texto estilizado.
setText(text)StyledTextDefine o conteúdo principal do texto estilizado.

TextFormatChip

Métodos

MétodoTipo de retornoBreve descrição
setLabel(label)TextFormatChipDefine o texto exibido no ícone.
setTextFormatIcon(icon)TextFormatChipDefine o ícone mostrado no ícone.
setUrl(url)TextFormatChipDefine o URL para navegar quando o ícone é clicado.

TextFormatElement

Métodos

MétodoTipo de retornoBreve descrição
setHyperlink(hyperlink)TextFormatElementDefine o elemento de formato de texto como um Hyperlink.
setListContainer(listContainer)TextFormatElementDefine o elemento de formato de texto como um ListContainer.
setStyledText(styledText)TextFormatElementDefine o elemento de formato de texto como um StyledText.
setText(text)TextFormatElementDefine o elemento de formato de texto como uma string de texto.
setTextFormatChip(chip)TextFormatElementDefine o elemento de formato de texto como um TextFormatChip.

TextFormatIcon

Métodos

MétodoTipo de retornoBreve descrição
setIconUrl(iconUrl)TextFormatIconDefine o URL do ícone.
setMaterialIconName(materialIconName)TextFormatIconDefine o nome do ícone do Material Design definido em Ícones do Material Design do Google.

TextStyle

Propriedades

PropriedadeTipoDescrição
STYLE_UNSPECIFIEDEnumNenhum estilo aplicado.
ITALICEnumEstilo itálico.
UNDERLINEEnumEstilo de sublinhado.
STRIKETHROUGHEnumEstilo tachado.
LINE_BREAKEnumQuebra de linha.
UPPERCASEEnumEstilo em maiúsculas.
CODEEnumEstilo de código.
CODE_BLOCKEnumEstilo do bloco de código.

TimeStamp

Métodos

MétodoTipo de retornoBreve descrição
setNanos(nanos)TimeStampDefine os nanos do carimbo de data/hora, representando o número de nanossegundos no segundo atual.
setSeconds(seconds)TimeStampDefine os segundos do carimbo de data/hora, representando o número de segundos desde a época Unix(1º de janeiro de 1970, 00:00:00 UTC).

UniversalActionResponse

Métodos

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

UniversalActionResponseBuilder

Métodos

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

UpdateDraftActionResponse

Métodos

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

UpdateDraftActionResponseBuilder

Métodos

MétodoTipo de retornoBreve descrição
build()UpdateDraftActionResponseCria e valida a resposta da ação de atualização do rascunho atual.
setSendStatus(sendStatus)UpdateDraftActionResponseBuilderDefine o campo de enumeração que determina se o e-mail será enviado após a ação de atualização.
setUpdateDraftBccRecipientsAction(updateDraftBccRecipientsAction)UpdateDraftActionResponseBuilderDefine uma ação que atualiza os destinatários em Cco de um rascunho de e-mail.
setUpdateDraftBodyAction(updateDraftBodyAction)UpdateDraftActionResponseBuilderDefina uma ação que atualiza o corpo de um rascunho de e-mail.
setUpdateDraftCcRecipientsAction(updateDraftCcRecipientsAction)UpdateDraftActionResponseBuilderDefine uma ação que atualiza os destinatários em cópia carbono 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 "Para" de um rascunho.

UpdateDraftBccRecipientsAction

Métodos

MétodoTipo de retornoBreve descrição
addUpdateBccRecipients(bccRecipientEmails)UpdateDraftBccRecipientsActionAtualiza os destinatários em 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 "Para" de um rascunho de e-mail.

UpdateInlinePreviewAction

Métodos

MétodoTipo de retornoBreve descrição
addCardWithId(cardWithId)UpdateInlinePreviewActionAdiciona o card para essa ação.
addExpiration(ttl)UpdateInlinePreviewActionAdiciona a expiração para essa ação.

UpdateMessageAction

Métodos

MétodoTipo de retornoBreve descrição
setMessage(message)UpdateMessageActionDefine a mensagem para essa ação.

UpdateWidget

Métodos

MétodoTipo de retornoBreve descrição
addSuggestion(text, value, selected, startIconUri, bottomText)UpdateWidgetAdiciona um novo item que pode ser selecionado para menus de seleção múltipla.

ValidationErrorSeverity

Propriedades

PropriedadeTipoDescrição
SEVERITY_UNSPECIFIEDEnumNão especificado.
CRITICALEnumCrítico: o erro é crítico e precisa ser corrigido antes da publicação.
WARNINGEnumAviso: o erro não é crítico e não está bloqueando a publicação.

ValueMetadata

Métodos

MétodoTipo de retornoBreve descrição
addCastableType(dataType)ValueMetadataAdiciona tipos permitidos opcionais que podem ser transmitidos dinamicamente para um dado de variável a esses metadados de valor.
addEnumValue(enumValue)ValueMetadataAdiciona um valor de string opcional aos valores de enumeração permitidos de uma variável. Esse campo só pode ser definido se o DataType estiver definido como o tipo String.
setDefaultValue(defaultValue)ValueMetadataDefine o valor padrão opcional da variável. Por exemplo, se o tipo de variável for booleano, o defaultValue poderá ser definido como "true" ou "false".

VariableData

Métodos

MétodoTipo de retornoBreve descrição
addBooleanValue(value)VariableDataAdiciona um valor booleano aos dados da variável.
addEmailAddress(emailAddress)VariableDataAdiciona um endereço de e-mail aos dados da variável.
addFloatValue(value)VariableDataAdiciona um valor de ponto flutuante aos dados da variável.
addGoogleUser(googleUser)VariableDataAdiciona um usuário do Google aos dados da variável.
addIntegerValue(value)VariableDataAdiciona um valor inteiro aos dados da variável.
addResourceData(resourceData)VariableDataAdiciona um valor ResourceData aos dados da variável.
addResourceReference(resourceReference)VariableDataAdiciona um ID de referência de recurso aos dados da variável.
addStringValue(value)VariableDataAdiciona um valor de string aos dados da variável.
addTimestampValue(value)VariableDataAdiciona um valor TimeStamp aos dados da variável.
addWorkflowTextFormat(workflowTextFormat)VariableDataAdiciona um valor WorkflowTextFormat aos dados da variável.

WorkflowAction

WorkflowTextFormat

Métodos

MétodoTipo de retornoBreve descrição
addTextFormatElement(textFormatElement)WorkflowTextFormatAdiciona um TextFormatElement ao formato de texto do fluxo de trabalho.

WorkflowValidationErrorAction

Métodos

MétodoTipo de retornoBreve descrição
setSeverity(severity)WorkflowValidationErrorActionDefine a gravidade do erro de validação.