AddOns Response Service

    AddOns Response Service

    This service allows scripts to configure and build Google Workspace add-ons.

    Classes

    Name Brief description
    Accessory Widget A builder for Chat Accessory Widget objects.
    Action An action that Google Workspace add-ons that extend Google Workspace Studio can use to render a new card.
    Action Response The actions that add-ons can use in cards or the host application.
    Action Response Builder A builder for Action Response objects.
    Add Ons Response Service Add Ons Response Service provides the ability to create responses for Google Workspace add-ons.
    Addon Compose Ui Action Response Represents an action on the addon compose ui.
    Addon Compose Ui Action Response Builder A builder for Addon Compose Ui Action Response objects.
    Addon Compose Ui Action Type An enum value that specifies the type of an Addon Compose Ui Action Response .
    Attachment Represents an attachment created by an add-on.
    Basic Data Type An enum that represents the basic generic data types.
    Calendar Event Action Response Represents a response that makes changes to the calendar event that the user is currently editing in reaction to an action taken in the UI, such as a button click.
    Calendar Event Action Response Builder A builder for Calendar Event Action Response objects.
    Chat Data Actions Response Builder A builder for Chat Data Action objects.
    Chat Message A Google Chat message .
    Color A Color object which represents a color in the RGBA color space.
    Compose Action Response The response object that may be returned from a callback method for compose action in a Gmail add-on .
    Compose Action Response Builder A builder for Compose Action Response objects.
    Composed Email Type An enum value that specifies whether the composed email is a standalone or reply draft.
    Content Type An enum value that specifies the content type of the content generated by a Update Draft Action Response .
    Create Message Action A builder for Chat Create Message Action objects.
    Data Actions Response Creates or updates a message in Google Chat.
    Data Type A DataType is used to set the type of a variable.
    Drive Items Selected Action Response Represents a response that makes changes to Drive while Drive items are selected and in reaction to an action taken in the UI, such as a button click.
    Drive Items Selected Action Response Builder A builder for Drive Items Selected Action Response objects.
    Dynamic Resource Definition A DynamicResourceDefinition is a building block for a Resource Fields Definition Retrieved Action , it can contain one or more numbers of Resource Field to dynamically define the number of output variables provided by a step in Google Workspace Studio.
    Editor File Scope Action Response Makes changes to an Editor, such as Google Docs, Sheets, or Slides in reaction to an action taken in the UI.
    Editor File Scope Action Response Builder A builder for Editor File Scope Action Response objects.
    End Navigation An enum that specifies the action during navigation.
    Error Actionability A Enum that represents the error actionability.
    Error Retryability A Enum that represents the retry-ability of action invocation when having an error.
    Font Weight An enum that represents the font weight of the styled text.
    Host App Action A HostAppAction is a type of Action that is handled by individual host apps.
    Hyperlink A Hyperlink element used in Text Format Element .
    Insert Section A builder for InsertSection objects.
    Insert Widget A builder for InsertWidget objects.
    Link The link object from a third-party resource which gets converted it to a smart chip in the host application.
    Link Preview Card action that displays a link preview card and smart chip in the host app.
    List Container Container for list items, where each list item can contain multiple Text Format Element .
    List Item A list item, where each list item can contain multiple Text Format Element .
    List Type An enum that represents the type of the list.
    Modify Card A builder for Modify Card objects that changes and updates an existing card's interface by passing the Modify Card object to a Action .
    Navigation A helper object that controls card navigation.
    Notification Displays a notification when users submit and close a dialog.
    On Close An enum that specifies what to do when a URL opened through an Open Link is closed.
    Open As An enum that specifies how to open a URL.
    Open Link Represents an action to open a link with some options.
    Remove Section A builder for Remove Section objects.
    Remove Widget A builder for RemoveWidget objects.
    Render Action Renders or updates a card by performing an Action in response to a user interaction.
    Render Action Builder A builder for Render Action objects.
    Resource Data Represents a application specific resource data, a resource data contains a collection of key-value pairs of variable names and Variable Data .
    Resource Field A ResourceField is a basic building block of a Dynamic Resource Definition , each resource field corresponds to a output variable of the current step.
    Resource Fields Definition Retrieved Action A Resource Fields Definition Retrieved Action is a type of Resource Fields Definition Retrieved Action that is used to retrieve the definition of a list of resource fields through the dynamic Resource Definition Provider function specified in the manifest.
    Resource Retrieved Action A ResourceRetrievedAction is used to retrieve custom resource content when needed, where the custom resource field is defined in the ResourceData.
    Resource Type An application specific resource type, the unique identifier of the resource type should have a corresponding WorkflowResourceDefinition.
    Return Element Error Action A ReturnElementErrorAction indicates that an error occurred during element invocation.
    Return Output Variables Action Contains output variables generated by the executed action in Google Workspace Studio.
    Save Workflow Action This action indicates that the host app (Google Workspace Studio) should save the agent.
    Send Status An enum value that specifies the send status of an Update Draft Action Response .
    Styled Text Text element with styles such as bold, italic and color.
    Text Format Chip A clickable chip in the text format.
    Text Format Element A text format element, which can be a Text Format Chip , Styled Text , Hyperlink , or List Container .
    Text Format Icon An icon that is displayed in a Text Format Chip .
    Text Style An enum that represents the style of the styled text.
    Time Stamp Represents a timestamp object which is can be added to a Variable Data .
    Universal Action Response The response object that may be returned from a method that creates universal action.
    Universal Action Response Builder A builder for the Universal Action Response objects.
    Update Draft Action Response Represents an action that updates the email draft that the user is currently editing.
    Update Draft Action Response Builder A builder for Update Draft Action Response objects.
    Update Draft Bcc Recipients Action Updates the Bcc recipients of an email draft.
    Update Draft Body Action Updates the email draft body.
    Update Draft Body Type An enum value that specifies the type of an Update Draft Body Action .
    Update Draft Cc Recipients Action Updates the Cc recipients of an email draft.
    Update Draft Subject Action Updates the subject line of an email draft.
    Update Draft To Recipients Action Updates the To recipients of an email draft.
    Update Inline Preview Action The Chat app previews a link in a message by adding or updating one or more cards.
    Update Message Action The Chat app updates text or cards in a message.
    Update Widget A builder for Update Widget objects.
    Validation Error Severity An enum that represents the severity of the validation error.
    Value Metadata A valueMetadata contains information about the potential values of a variable.
    Variable Data Represents a variable data which can contain a collection of values in various types.
    Workflow Action A WorkflowAction is a type of Host App Action that is used to perform a specific action in Google Workspace Studio.
    Workflow Text Format A block of text with rich formatting options including styles, hyperlinks, and interactive elements defined in Text Format Element .
    Workflow Validation Error Action This action indicates that the host app (Google Workspace Studio) should display a validation error.

    AccessoryWidget

    Methods

    Method Return type Brief description
    add Widget(widget)
    		Accessory Widget Sets the widget for this action.

    Action

    Methods

    Method Return type Brief description
    add Modify Card(modifyCard)
    		Action Adds a ModifyCard operation to the action.
    add Navigation(navigation)
    		Action Adds a card navigation to the action.

    ActionResponse

    Methods

    Method Return type Brief description
    print Json()
    		String Prints the JSON representation of this object.

    ActionResponseBuilder

    Methods

    Method Return type Brief description
    add Modify Card(modifyCard)
    		Action Response Builder Sets the modify card operation to the action.
    build()
    		Action Response Builds the current action response and validates it.
    set Link Preview(linkPreview)
    		Action Response Builder Sets the LinkPreview to the action.
    set Navigation(navigation)
    		Action Response Builder Sets the response to a Navigation action.
    set Notification(notification)
    		Action Response Builder Sets the notification to display when the action is activated.
    set Open Link(openLink)
    		Action Response Builder Sets the URL to navigate to when the action is activated.
    set State Changed(stateChanged)
    		Action Response Builder Sets a flag to indicate that this action changed the existing data state.

    AddOnsResponseService

    Properties

    Property Type Description
    Addon Compose Ui Action Type
    		Addon Compose Ui Action Type The Addon Compose Ui Action Type enumeration.
    Composed Email Type
    		Composed Email Type The Composed Email Type enumeration.
    Content Type
    		Content Type The Content Type enumeration.
    End Navigation
    		End Navigation The End Navigation enumeration.
    On Close
    		On Close The On Close enumeration.
    Open As
    		Open As The Open As enumeration.
    Send Status
    		Send Status The Send Status enumeration.
    Update Draft Body Type
    		Update Draft Body Type The Update Draft Body Type enumeration.

    Methods

    Method Return type Brief description
    new Accessory Widget()
    		Accessory Widget Creates a new Accessory Widget .
    new Action()
    		Action Creates a new Action .
    new Action Response Builder()
    		Action Response Builder Creates a Action Response Builder .
    new Addon Compose Ui Action Response Builder()
    		Addon Compose Ui Action Response Builder Creates a Addon Compose Ui Action Response Builder .
    new Attachment()
    		Attachment Creates a Attachment .
    new Calendar Event Action Response Builder()
    		Calendar Event Action Response Builder Creates a Calendar Event Action Response Builder .
    new Chat Data Action Builder()
    		Chat Data Actions Response Builder Creates a Chat Data Actions Response Builder .
    new Chat Message()
    		Chat Message Creates a Chat Message .
    new Compose Action Response Builder()
    		Compose Action Response Builder Creates a Compose Action Response Builder .
    new Create Message Action()
    		Create Message Action Creates a Create Message Action .
    new Drive Items Selected Action Response Builder()
    		Drive Items Selected Action Response Builder Creates a Drive Items Selected Action Response Builder .
    new Editor File Scope Action Response Builder()
    		Editor File Scope Action Response Builder Creates a Editor File Scope Action Response Builder .
    new Link Preview()
    		Link Preview Creates a Link Preview .
    new Navigation()
    		Navigation Creates a Navigation .
    new Notification()
    		Notification Creates a Notification .
    new Open Link()
    		Open Link Creates a Open Link .
    new Render Action Builder()
    		Render Action Builder Creates a new Render Action Builder .
    new Universal Action Response Builder()
    		Universal Action Response Builder Creates a Universal Action Response Builder .
    new Update Draft Action Response Builder()
    		Update Draft Action Response Builder Creates a Update Draft Action Response Builder .
    new Update Draft Bcc Recipients Action()
    		Update Draft Bcc Recipients Action Creates a Update Draft Bcc Recipients Action ;
    new Update Draft Body Action()
    		Update Draft Body Action Creates a Update Draft Body Action .
    new Update Draft Cc Recipients Action()
    		Update Draft Cc Recipients Action Creates a Update Draft Cc Recipients Action .
    new Update Draft Subject Action()
    		Update Draft Subject Action Creates a Update Draft Subject Action .
    new Update Draft To Recipients Action()
    		Update Draft To Recipients Action Creates a Update Draft To Recipients Action .
    new Update Inline Preview Action()
    		Update Inline Preview Action Creates a Update Inline Preview Action .
    new Update Message Action()
    		Update Message Action Creates a Update Message Action .

    AddonComposeUiActionResponse

    Methods

    Method Return type Brief description
    print Json()
    		String Prints the JSON representation of this object.

    AddonComposeUiActionResponseBuilder

    Methods

    Method Return type Brief description
    build()
    		Addon Compose Ui Action Response Builds the current addon compose ui action response and validates it.
    set Type(type)
    		Addon Compose Ui Action Response Builder Sets the enum field that determines the addon compose ui action.

    AddonComposeUiActionType

    Properties

    Property Type Description
    DISMISS
    		Enum Default.

    Attachment

    Methods

    Method Return type Brief description
    set Icon Url(iconUrl)
    		Attachment Sets the icon URL for the attachment.
    set Mime Type(mimeType)
    		Attachment Sets the MIME type for the attachment.
    set Resource Url(resourceUrl)
    		Attachment Sets the resource URL for the attachment.
    set Title(title)
    		Attachment Sets the title for the attachment.

    BasicDataType

    Properties

    Property Type Description
    BASIC_TYPE_UNSPECIFIED
    		Enum Default value.
    STRING
    		Enum A string of characters.
    INTEGER
    		Enum An integer value.
    FLOAT
    		Enum A floating point number.
    TIMESTAMP
    		Enum A timestamp in ISO 8601 format.
    BOOLEAN
    		Enum A boolean value.
    EMAIL_ADDRESS
    		Enum A string in the format of an email address.
    GOOGLE_USER
    		Enum A user of the Google services, in the format of “users/encoded_GAIA_ID”
    FILE
    		Enum A file type.
    FORMATTED_TEXT
    		Enum A text with rich formatting.

    CalendarEventActionResponse

    Methods

    Method Return type Brief description
    print Json()
    		String Prints the JSON representation of this object.

    CalendarEventActionResponseBuilder

    Methods

    Method Return type Brief description
    add Attachments(attachments)
    		Calendar Event Action Response Builder Specifies that the response should add the attachments to the Calendar event when the associated UI action is taken.
    add Attendees(emails)
    		Calendar Event Action Response Builder Specifies that the response should add the indicated attendees to the Calendar event when the associated UI action is taken.
    build()
    		Calendar Event Action Response Builds the current Calendar event action response and validates it.
    set Conference Data(conferenceData)
    		Calendar Event Action Response Builder Specifies that the response should set the indicated conference data to the Calendar event when the associated UI action is taken.

    ChatDataActionsResponseBuilder

    Methods

    Method Return type Brief description
    build()
    		Data Actions Response Builds the current action response.
    set Create Chat Message Action(createMessageAction)
    		Chat Data Actions Response Builder Sets the Create Message Action for this Data Actions Response .
    set Update Chat Message Action(updateMessageAction)
    		Chat Data Actions Response Builder Sets the Update Message Action for this Data Actions Response .
    set Update Inline Preview Action(updateInlinePreviewAction)
    		Chat Data Actions Response Builder Sets the Update Inline Preview Action for this Data Actions Response .

    ChatMessage

    Methods

    Method Return type Brief description
    add Accessory Widget(accessoryWidget)
    		Chat Message Sets the accessoryWidget for this action.
    add Card With Id(cardWithId)
    		Chat Message Sets the card of the message.
    set Text(text)
    		Chat Message Sets the text of the message.

    Color

    Methods

    Method Return type Brief description
    set Alpha(alpha)
    		Color Sets the alpha component of the color.
    set Blue(blue)
    		Color Sets the blue component of the color.
    set Green(green)
    		Color Sets the green component of the color.
    set Red(red)
    		Color Sets the red component of the color.

    ComposeActionResponse

    Methods

    Method Return type Brief description
    print Json()
    		String Prints the JSON representation of this object.

    ComposeActionResponseBuilder

    Methods

    Method Return type Brief description
    build()
    		Compose Action Response Builds the current compose action response and validates it.
    set Gmail Draft(draft)
    		Compose Action Response Builder Sets the draft Gmail Message created using Gmail Message.createDraftReply(body) or similar functions.

    ComposedEmailType

    Properties

    Property Type Description
    REPLY_AS_DRAFT
    		Enum A draft that is a reply to another message.
    STANDALONE_DRAFT
    		Enum A draft that is a standalone message.

    ContentType

    Properties

    Property Type Description
    TEXT
    		Enum Indicates that the generated content is plain text.
    MUTABLE_HTML
    		Enum Indicates that the generated content is formatted as HTML.
    IMMUTABLE_HTML
    		Enum Indicates that the generated content is formatted as HTML, but this content cannot be edited after it is generated.

    CreateMessageAction

    Methods

    Method Return type Brief description
    set Message(message)
    		Create Message Action Sets the message for this action.

    DataActionsResponse

    Methods

    Method Return type Brief description
    print Json()
    		String Prints the JSON representation of this object.

    DataType

    Methods

    Method Return type Brief description
    set Basic Data Type(basicDataType)
    		Data Type Sets the data type to one of the supported Basic Data Type s.
    set Resource Type(resourceType)
    		Data Type Sets the data type to a custom defined Resource Type .
    set Value Metadata(valueMetadata)
    		Data Type Sets the Value Metadata , which contains type-related information related to the variable.

    DriveItemsSelectedActionResponse

    Methods

    Method Return type Brief description
    print Json()
    		String Prints the JSON representation of this object.

    DriveItemsSelectedActionResponseBuilder

    Methods

    Method Return type Brief description
    build()
    		Drive Items Selected Action Response Builds the current Drive action response.
    request File Scope(itemId)
    		Drive Items Selected Action Response Builder Specifies that the response requests file scope for the contextually-relevant item in Drive.

    DynamicResourceDefinition

    Methods

    Method Return type Brief description
    add Resource Field(resourceField)
    		Dynamic Resource Definition Adds a resource field to the dynamic resource definition.
    set Resource Id(resourceId)
    		Dynamic Resource Definition Sets the ID for the dynamic resource definition, this ID corresponds to the workflow Resource Definition Id in the manifest.

    EditorFileScopeActionResponse

    Methods

    Method Return type Brief description
    print Json()
    		String Prints the JSON representation of this object.

    EditorFileScopeActionResponseBuilder

    Methods

    Method Return type Brief description
    build()
    		Editor File Scope Action Response Builds the current Editor action response.
    request File Scope For Active Document()
    		Editor File Scope Action Response Builder Requests the drive.file scope for the current active Editor document.

    EndNavigation

    Properties

    Property Type Description
    ACTION_UNSPECIFIED
    		Enum Action unspecified.
    CLOSE_DIALOG
    		Enum Closes a dialog .
    CLOSE_DIALOG_AND_EXECUTE
    		Enum Closes a dialog and refreshes the card that opened the dialog.

    ErrorActionability

    Properties

    Property Type Description
    ERROR_ACTIONABILITY_UNSPECIFIED
    		Enum Unspecified.
    NOT_ACTIONABLE
    		Enum The error is not fixable by the user through the configuration card.
    ACTIONABLE
    		Enum The error is fixable by the user through the configuration card.

    ErrorRetryability

    Properties

    Property Type Description
    RETRYABILITY_UNSPECIFIED
    		Enum Unspecified.
    NOT_RETRYABLE
    		Enum The error is not retryable, the flow terminates after the first try.
    RETRYABLE
    		Enum The error is retryable, Workflow is going to try to execute the Step for up to 5 times.

    FontWeight

    Properties

    Property Type Description
    FONT_WEIGHT_UNSPECIFIED
    		Enum Standard weight with normal thickness.
    LIGHT
    		Enum Lighter weight with reduced thickness.
    MEDIUM
    		Enum Intermediate weight between light and bold.
    BOLD
    		Enum Heavier weight with increased thickness.

    HostAppAction

    Methods

    Method Return type Brief description
    set Workflow Action(workflowAction)
    		Host App Action Sets the host app action to Workflow action.

    Methods

    Method Return type Brief description
    set Link(link)
    		Hyperlink Sets the destination URL of the hyperlink.
    set Text(text)
    		Hyperlink Sets the text of the hyperlink.

    InsertSection

    Methods

    Method Return type Brief description
    insert At Top(onCardTop)
    		Insert Section Sets the onCardTop flag, which indicates whether the new section should be inserted at the top of the card.
    insert Below Section(sectionId)
    		Insert Section Sets the section ID, and the new section is inserted below it.
    set Section(section)
    		Insert Section Sets the card section to be inserted.

    InsertWidget

    Methods

    Method Return type Brief description
    insert Above Widget(widgetId)
    		Insert Widget Sets the widget ID, and the new widget is inserted above the widget with the given ID.
    insert Below Widget(widgetId)
    		Insert Widget Sets the widget ID, and the new widget is inserted below the widget with the given ID.
    set Widget(widget)
    		Insert Widget Sets the Widget to be inserted.

    Methods

    Method Return type Brief description
    set Title(title)
    		Link Sets the title of the link.
    set Url(url)
    		Link Sets the URL of the link.

    LinkPreview

    Methods

    Method Return type Brief description
    print Json()
    		String Prints the JSON representation of this object.
    set Link Preview Title(title)
    		Link Preview Sets the title that displays in the link preview above the preview card.
    set Preview Card(previewCard)
    		Link Preview Sets the card that displays information about a link from a third-party or non-Google service.
    set Title(title)
    		Link Preview Sets the title that displays in the smart chip for the link preview.

    ListContainer

    Methods

    Method Return type Brief description
    add List Item(listItem)
    		List Container Adds a list item to the list container.
    set List Nest Level(listLevel)
    		List Container Sets the level of the list, starts from 0 for the top level, and increases by 1 for each nested list.
    set List Type(listType)
    		List Container Sets the type of the list to be ordered or unordered.

    ListItem

    Methods

    Method Return type Brief description
    add Text Format Element(textFormatElement)
    		List Item Adds a Text Format Element to the list item.

    ListType

    Properties

    Property Type Description
    LIST_TYPE_UNSPECIFIED
    		Enum Default value.
    ORDERED
    		Enum Ordered list.
    UNORDERED
    		Enum Unordered list.

    ModifyCard

    Methods

    Method Return type Brief description
    set Insert Section(insertSection)
    		Modify Card Sets the Insert Section for this modify card object.
    set Insert Widget(insertWidget)
    		Modify Card Sets the Insert Widget for this modify card object.
    set Remove Section(removeSection)
    		Modify Card Sets the Remove Section for this modify card object.
    set Remove Widget(removeWidget)
    		Modify Card Sets the Remove Widget for this modify card object.
    set Replace Section(replacementSection)
    		Modify Card Sets the replacement Card Section for this modify card object, the replacement section should have the same id as an existing card section.
    set Replace Widget(replacementWidget)
    		Modify Card Sets the replacement widget for this modify card object, the replacement widget should have the same id as an existing widget.
    set Update Widget(updateWidget)
    		Modify Card Sets the Update Widget for this modify card object.

    Methods

    Method Return type Brief description
    pop Card()
    		Navigation
    pop To Named Card(cardName)
    		Navigation
    pop To Root()
    		Navigation
    print Json()
    		String Prints the JSON representation of this object.
    push Card(card)
    		Navigation Pushes the given card onto the stack.
    set End Navigation(endNavigation)
    		Navigation Sets the end navigation action.
    update Card(card)
    		Navigation Does an in-place replacement of the current card.

    Notification

    Methods

    Method Return type Brief description
    set Text(text)
    		Notification Sets the text to show in the notification.

    OnClose

    Properties

    Property Type Description
    NOTHING
    		Enum Do nothing on close.
    RELOAD
    		Enum Reloads the add-on on when the window closes.

    OpenAs

    Properties

    Property Type Description
    FULL_SIZE
    		Enum Open in a full window or tab.
    OVERLAY
    		Enum Open as an overlay such as a pop-up.

    Methods

    Method Return type Brief description
    set On Close(onClose)
    		Open Link Sets the behavior of the URL action when the URL window or tab is closed.
    set Open As(openAs)
    		Open Link Sets the behavior of URL when it is opened.
    set Url(url)
    		Open Link Sets the URL to be opened.

    RemoveSection

    Methods

    Method Return type Brief description
    set Section Id(sectionId)
    		Remove Section Sets the section ID of the section to be removed.

    RemoveWidget

    Methods

    Method Return type Brief description
    set Widget Id(widgetId)
    		Remove Widget Sets the widget ID of the widget to be removed.

    RenderAction

    Methods

    Method Return type Brief description
    print Json()
    		String Prints the JSON representation of this object.

    RenderActionBuilder

    Methods

    Method Return type Brief description
    build()
    		Render Action Builds the current render action and validates it.
    set Action(action)
    		Render Action Builder Sets the action that add-ons can use to update the UI to the render action.
    set Host App Action(hostAppAction)
    		Render Action Builder Sets the Host App Action handled by individual host apps to the render action.

    ResourceData

    Methods

    Method Return type Brief description
    add Variable Data(key, value)
    		Resource Data Adds a Variable Data keyed by its variable name, a value is overwritten if the key already exists.
    set Variable Data Map(fields)
    		Resource Data Sets the map of the variable data keyed by variable names.

    ResourceField

    Methods

    Method Return type Brief description
    set Data Type(dataType)
    		Resource Field Sets the data type of the field, allows other steps to filter the variables by type at selection.
    set Display Text(displayText)
    		Resource Field Sets the description of the field that is displayed to the end user during variable selection in subsequent steps.
    set Selector(selector)
    		Resource Field Sets a key for the provider function to provide the value to during the step's execution.

    ResourceFieldsDefinitionRetrievedAction

    Methods

    Method Return type Brief description
    add Dynamic Resource Definition(dynamicResourceDefinition)
    		Resource Fields Definition Retrieved Action Adds a Dynamic Resource Definition to the resource fields definition retrieved action.

    ResourceRetrievedAction

    Methods

    Method Return type Brief description
    set Resource Data(resourceData)
    		Resource Retrieved Action Sets the Resource Data to the resource retrieved action to provide values to the dynamic resource fields or custom resource fields.

    ResourceType

    Methods

    Method Return type Brief description
    set Workflow Resource Definition Id(resourceType)
    		Resource Type Sets the workflow resource definition id.

    ReturnElementErrorAction

    Methods

    Method Return type Brief description
    set Error Actionability(errorActionability)
    		Return Element Error Action Sets the error actionability, an error should be actionable if it can be resolved by re-configuring the step.
    set Error Log(log)
    		Return Element Error Action Sets the error log to be displayed to the end user at Workflow's activity feed.
    set Error Retryability(errorRetryability)
    		Return Element Error Action Sets the error retry-ability, the flow terminates after the first try if an error is not retryable.

    ReturnOutputVariablesAction

    Methods

    Method Return type Brief description
    add Variable Data(key, value)
    		Return Output Variables Action Adds a variable data keyed by its variable name, a value is overwritten if the key already exists.
    set Log(log)
    		Return Output Variables Action Sets the Log of the executed workflow action to the end user at Workflow's activity feed.
    set Variable Data Map(variables)
    		Return Output Variables Action Sets the map of the variable data keyed by variable name, a value is overwritten if the key already exists.

    SaveWorkflowAction

    SendStatus

    Properties

    Property Type Description
    NOT_SEND
    		Enum Default.
    CONTINUE_SEND
    		Enum Continue sending the email after updating the draft.

    StyledText

    Methods

    Method Return type Brief description
    add Style(style)
    		Styled Text Sets the style of the styled text, can apply multiple styles to a single styled text.
    set Color(color)
    		Styled Text Sets the color of the styled text.
    set Font Weight(fontWeight)
    		Styled Text Sets the font weight of the styled text.
    set Text(text)
    		Styled Text Sets the main content of the styled text.

    TextFormatChip

    Methods

    Method Return type Brief description
    set Label(label)
    		Text Format Chip Sets the text displayed in the chip.
    set Text Format Icon(icon)
    		Text Format Chip Sets the icon displayed in the chip.
    set Url(url)
    		Text Format Chip Sets the URL to navigate to when the chip is clicked.

    TextFormatElement

    Methods

    Method Return type Brief description
    set Hyperlink(hyperlink)
    		Text Format Element Sets the text format element as a Hyperlink .
    set List Container(listContainer)
    		Text Format Element Sets the text format element as a List Container .
    set Styled Text(styledText)
    		Text Format Element Sets the text format element as a Styled Text .
    set Text(text)
    		Text Format Element Sets the text format element as a text string.
    set Text Format Chip(chip)
    		Text Format Element Sets the text format element as a Text Format Chip .

    TextFormatIcon

    Methods

    Method Return type Brief description
    set Icon Url(iconUrl)
    		Text Format Icon Sets the icon URL.
    set Material Icon Name(materialIconName)
    		Text Format Icon Sets the material icon name defined in Google Material Icons.

    TextStyle

    Properties

    Property Type Description
    STYLE_UNSPECIFIED
    		Enum No style applied.
    ITALIC
    		Enum Italic style.
    UNDERLINE
    		Enum Underline style.
    STRIKETHROUGH
    		Enum Strikethrough style.
    LINE_BREAK
    		Enum Line break.
    UPPERCASE
    		Enum Uppercase style.
    CODE
    		Enum Code style.
    CODE_BLOCK
    		Enum Code block style.

    TimeStamp

    Methods

    Method Return type Brief description
    set Nanos(nanos)
    		Time Stamp Sets the nanos of the timestamp, it represents the number of nanoseconds within the current second.
    set Seconds(seconds)
    		Time Stamp Sets the seconds of the timestamp, it represents the number of seconds since the Unix epoch(January 1, 1970, 00:00:00 UTC).

    UniversalActionResponse

    Methods

    Method Return type Brief description
    print Json()
    		String Prints the JSON representation of this object.

    UniversalActionResponseBuilder

    Methods

    Method Return type Brief description
    build()
    		Universal Action Response Builds the current universal action response and validates it.
    display Add On Cards(cardObjects)
    		Universal Action Response Builder Displays the add-on with the specified cards.
    set Open Link(openLink)
    		Universal Action Response Builder Sets the URL to open when the universal action is selected.

    UpdateDraftActionResponse

    Methods

    Method Return type Brief description
    print Json()
    		String Prints the JSON representation of this object.

    UpdateDraftActionResponseBuilder

    Methods

    Method Return type Brief description
    build()
    		Update Draft Action Response Builds the current update draft action response and validates it.
    set Send Status(sendStatus)
    		Update Draft Action Response Builder Sets the enum field that determines whether or not the email sends after the update action.
    set Update Draft Bcc Recipients Action(updateDraftBccRecipientsAction)
    		Update Draft Action Response Builder Sets an action that updates the email Bcc recipients of a draft.
    set Update Draft Body Action(updateDraftBodyAction)
    		Update Draft Action Response Builder Set an action that updates the email body of a draft.
    set Update Draft Cc Recipients Action(updateDraftCcRecipientsAction)
    		Update Draft Action Response Builder Sets an action that updates the Cc recipients of a draft.
    set Update Draft Subject Action(updateDraftSubjectAction)
    		Update Draft Action Response Builder Sets an action that updates the subject line of a draft.
    set Update Draft To Recipients Action(updateDraftToRecipientsAction)
    		Update Draft Action Response Builder Sets an action that updates the To recipients of a draft.

    UpdateDraftBccRecipientsAction

    Methods

    Method Return type Brief description
    add Update Bcc Recipients(bccRecipientEmails)
    		Update Draft Bcc Recipients Action Updates the Bcc recipients of an email draft.

    UpdateDraftBodyAction

    Methods

    Method Return type Brief description
    add Update Content(content, contentType)
    		Update Draft Body Action Adds the specified content to the draft body.
    set Update Type(updateType)
    		Update Draft Body Action Sets the Update Draft Body Type of this update action on the draft body.

    UpdateDraftBodyType

    Properties

    Property Type Description
    IN_PLACE_INSERT
    		Enum Default.
    INSERT_AT_START
    		Enum Update actions insert content at the start of message body.
    INSERT_AT_END
    		Enum Update actions insert content at the end of the message body.

    UpdateDraftCcRecipientsAction

    Methods

    Method Return type Brief description
    add Update Cc Recipients(ccRecipientEmails)
    		Update Draft Cc Recipients Action Updates the Cc recipients of an email draft.

    UpdateDraftSubjectAction

    Methods

    Method Return type Brief description
    add Update Subject(subject)
    		Update Draft Subject Action Updates the subject line of an email draft.

    UpdateDraftToRecipientsAction

    Methods

    Method Return type Brief description
    add Update To Recipients(toRecipientEmails)
    		Update Draft To Recipients Action Updates the To recipients of an email draft.

    UpdateInlinePreviewAction

    Methods

    Method Return type Brief description
    add Card With Id(cardWithId)
    		Update Inline Preview Action Adds the card for this action.
    add Expiration(ttl)
    		Update Inline Preview Action Adds the expiration for this action.

    UpdateMessageAction

    Methods

    Method Return type Brief description
    set Message(message)
    		Update Message Action Sets the message for this action.

    UpdateWidget

    Methods

    Method Return type Brief description
    add Suggestion(text, value, selected, startIconUri, bottomText)
    		Update Widget Adds a new item that can be selected, for multi-select menus.

    ValidationErrorSeverity

    Properties

    Property Type Description
    SEVERITY_UNSPECIFIED
    		Enum Unspecified.
    CRITICAL
    		Enum Critical, the error is critical and must be fixed before publish.
    WARNING
    		Enum Warning, the error is non-critical and is not blocking publish.

    ValueMetadata

    Methods

    Method Return type Brief description
    add Castable Type(dataType)
    		Value Metadata Adds a optional allowed types that can be dynamically casted for a variable data to this value metadata.
    add Enum Value(enumValue)
    		Value Metadata Adds an optional string value to the allowed enum values of a variable, this field can only be set if the Data Type is set to String type.
    set Default Value(defaultValue)
    		Value Metadata Sets the optional default value of the variable, example, if the variable type is boolean, defaultValue may be set to " true " or " false ".

    VariableData

    Methods

    Method Return type Brief description
    add Boolean Value(value)
    		Variable Data Adds a boolean value to the variable data.
    add Email Address(emailAddress)
    		Variable Data Adds an email address to the variable data.
    add Float Value(value)
    		Variable Data Adds a float value to the variable data.
    add Google User(googleUser)
    		Variable Data Adds a google user to the variable data.
    add Integer Value(value)
    		Variable Data Adds an integer value to the variable data.
    add Resource Data(resourceData)
    		Variable Data Adds a Resource Data value to the variable data.
    add Resource Reference(resourceReference)
    		Variable Data Adds a resource reference ID to the variable data.
    add String Value(value)
    		Variable Data Adds a string value to the variable data.
    add Timestamp Value(value)
    		Variable Data Adds a Time Stamp value to the variable data.
    add Workflow Text Format(workflowTextFormat)
    		Variable Data Adds a Workflow Text Format value to the variable data.

    WorkflowAction

    WorkflowTextFormat

    Methods

    Method Return type Brief description
    add Text Format Element(textFormatElement)
    		Workflow Text Format Adds a Text Format Element to the workflow text format.

    WorkflowValidationErrorAction

    Methods

    Method Return type Brief description
    set Severity(severity)
    		Workflow Validation Error Action Sets the severity of the validation error.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: