Class UniversalActionResponseBuilder

  • UniversalActionResponseBuilder is used to build UniversalActionResponse objects.

  • The build() method validates and creates the UniversalActionResponse.

  • The displayAddOnCards() method allows you to show the add-on with specified cards.

  • The setOpenLink() method sets the URL that opens when a universal action is chosen.
UniversalActionResponseBuilder

A builder for the UniversalActionResponse objects.

Methods

MethodReturn typeBrief description
build()UniversalActionResponseBuilds the current universal action response and validates it.
displayAddOnCards(cardObjects)UniversalActionResponseBuilderDisplays the add-on with the specified cards.
setOpenLink(openLink)UniversalActionResponseBuilderSets the URL to open when the universal action is selected.

Detailed documentation

build()

Builds the current universal action response and validates it.

Return

UniversalActionResponse — A validated UniversalActionResponse.

Throws

Error — if the constructed universal action response isn't valid.

displayAddOnCards(cardObjects)

Displays the add-on with the specified cards.

Parameters

NameTypeDescription
cardObjectsObject[]An array of Cards to display.

Return

UniversalActionResponseBuilder — This object, for chaining.

Sets the URL to open when the universal action is selected.

Parameters

NameTypeDescription
openLinkOpenLinkThe link object to use.

Return

UniversalActionResponseBuilder — This object, for chaining.