t

com.google.apps.card.v1

ActionOrBuilder

trait ActionOrBuilder extends MessageOrBuilder

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ActionOrBuilder
  2. MessageOrBuilder
  3. MessageLiteOrBuilder
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def findInitializationErrors(): List[String]
    Definition Classes
    MessageOrBuilder
  2. abstract def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    MessageOrBuilder
  3. abstract def getAllWidgetsAreRequired(): Boolean

    Optional. If this is true, then all widgets are considered required by
this action.

[Google Workspace add-ons and Chat
apps](https://developers.google.com/workspace/extend):


    Optional. If this is true, then all widgets are considered required by
this action.

[Google Workspace add-ons and Chat
apps](https://developers.google.com/workspace/extend):

    bool all_widgets_are_required = 7;

    returns

    The allWidgetsAreRequired.

  4. abstract def getDefaultInstanceForType(): Message
    Definition Classes
    MessageOrBuilder → MessageLiteOrBuilder
  5. abstract def getDescriptorForType(): Descriptor
    Definition Classes
    MessageOrBuilder
  6. abstract def getField(arg0: FieldDescriptor): AnyRef
    Definition Classes
    MessageOrBuilder
  7. abstract def getFunction(): String

    A custom function to invoke when the containing element is
clicked or otherwise activated.

For example usage, see [Read form
data](https://developers.google.com/workspace/chat/read-form-data).


    A custom function to invoke when the containing element is
clicked or otherwise activated.

For example usage, see [Read form
data](https://developers.google.com/workspace/chat/read-form-data).

    string function = 1;

    returns

    The function.

  8. abstract def getFunctionBytes(): ByteString

    A custom function to invoke when the containing element is
clicked or otherwise activated.

For example usage, see [Read form
data](https://developers.google.com/workspace/chat/read-form-data).


    A custom function to invoke when the containing element is
clicked or otherwise activated.

For example usage, see [Read form
data](https://developers.google.com/workspace/chat/read-form-data).

    string function = 1;

    returns

    The bytes for function.

  9. abstract def getInitializationErrorString(): String
    Definition Classes
    MessageOrBuilder
  10. abstract def getInteraction(): Interaction

    Optional. Required when opening a
[dialog](https://developers.google.com/workspace/chat/dialogs).

What to do in response to an interaction with a user, such as a user
clicking a button in a card message.

If unspecified, the app responds by executing an `action`—like opening a
link or running a function—as normal.

By specifying an `interaction`, the app can respond in special interactive
ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can
open a [dialog](https://developers.google.com/workspace/chat/dialogs). When
specified, a loading indicator isn't shown. If specified for
an add-on, the entire card is stripped and nothing is shown in the client.

[Google Chat apps](https://developers.google.com/workspace/chat):


    Optional. Required when opening a
[dialog](https://developers.google.com/workspace/chat/dialogs).

What to do in response to an interaction with a user, such as a user
clicking a button in a card message.

If unspecified, the app responds by executing an `action`—like opening a
link or running a function—as normal.

By specifying an `interaction`, the app can respond in special interactive
ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can
open a [dialog](https://developers.google.com/workspace/chat/dialogs). When
specified, a loading indicator isn't shown. If specified for
an add-on, the entire card is stripped and nothing is shown in the client.

[Google Chat apps](https://developers.google.com/workspace/chat):

    .google.apps.card.v1.Action.Interaction interaction = 5;

    returns

    The interaction.

  11. abstract def getInteractionValue(): Int

    Optional. Required when opening a
[dialog](https://developers.google.com/workspace/chat/dialogs).

What to do in response to an interaction with a user, such as a user
clicking a button in a card message.

If unspecified, the app responds by executing an `action`—like opening a
link or running a function—as normal.

By specifying an `interaction`, the app can respond in special interactive
ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can
open a [dialog](https://developers.google.com/workspace/chat/dialogs). When
specified, a loading indicator isn't shown. If specified for
an add-on, the entire card is stripped and nothing is shown in the client.

[Google Chat apps](https://developers.google.com/workspace/chat):


    Optional. Required when opening a
[dialog](https://developers.google.com/workspace/chat/dialogs).

What to do in response to an interaction with a user, such as a user
clicking a button in a card message.

If unspecified, the app responds by executing an `action`—like opening a
link or running a function—as normal.

By specifying an `interaction`, the app can respond in special interactive
ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can
open a [dialog](https://developers.google.com/workspace/chat/dialogs). When
specified, a loading indicator isn't shown. If specified for
an add-on, the entire card is stripped and nothing is shown in the client.

[Google Chat apps](https://developers.google.com/workspace/chat):

    .google.apps.card.v1.Action.Interaction interaction = 5;

    returns

    The enum numeric value on the wire for interaction.

  12. abstract def getLoadIndicator(): LoadIndicator

    Specifies the loading indicator that the action displays while
making the call to the action.


    Specifies the loading indicator that the action displays while
making the call to the action.

    .google.apps.card.v1.Action.LoadIndicator load_indicator = 3;

    returns

    The loadIndicator.

  13. abstract def getLoadIndicatorValue(): Int

    Specifies the loading indicator that the action displays while
making the call to the action.


    Specifies the loading indicator that the action displays while
making the call to the action.

    .google.apps.card.v1.Action.LoadIndicator load_indicator = 3;

    returns

    The enum numeric value on the wire for loadIndicator.

  14. abstract def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    MessageOrBuilder
  15. abstract def getParameters(index: Int): ActionParameter

    List of action parameters.


    List of action parameters.

    repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;

  16. abstract def getParametersCount(): Int

    List of action parameters.


    List of action parameters.

    repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;

  17. abstract def getParametersList(): List[ActionParameter]

    List of action parameters.


    List of action parameters.

    repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;

  18. abstract def getParametersOrBuilder(index: Int): ActionParameterOrBuilder

    List of action parameters.


    List of action parameters.

    repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;

  19. abstract def getParametersOrBuilderList(): List[_ <: ActionParameterOrBuilder]

    List of action parameters.


    List of action parameters.

    repeated .google.apps.card.v1.Action.ActionParameter parameters = 2;

  20. abstract def getPersistValues(): Boolean

    Indicates whether form values persist after the action. The default value
is `false`.

If `true`, form values remain after the action is triggered. To let the
user make changes while the action is being processed, set
[`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator)
to `NONE`. For [card
messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create)
in Chat apps, you must also set the action's
[`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype)
to `UPDATE_MESSAGE` and use the same
[`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId)
from the card that contained the action.

If `false`, the form values are cleared when the action is triggered.
To prevent the user from making changes while the action is being
processed, set
[`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator)
to `SPINNER`.


    Indicates whether form values persist after the action. The default value
is `false`.

If `true`, form values remain after the action is triggered. To let the
user make changes while the action is being processed, set
[`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator)
to `NONE`. For [card
messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create)
in Chat apps, you must also set the action's
[`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype)
to `UPDATE_MESSAGE` and use the same
[`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId)
from the card that contained the action.

If `false`, the form values are cleared when the action is triggered.
To prevent the user from making changes while the action is being
processed, set
[`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator)
to `SPINNER`.

    bool persist_values = 4;

    returns

    The persistValues.

  21. abstract def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    MessageOrBuilder
  22. abstract def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    MessageOrBuilder
  23. abstract def getRequiredWidgets(index: Int): String

    Optional. Fill this list with the names of widgets that this Action
needs for a valid submission.

If the widgets listed here don't have a value when this Action is invoked,
the form submission is aborted.

[Google Workspace add-ons and Chat
apps](https://developers.google.com/workspace/extend):


    Optional. Fill this list with the names of widgets that this Action
needs for a valid submission.

If the widgets listed here don't have a value when this Action is invoked,
the form submission is aborted.

[Google Workspace add-ons and Chat
apps](https://developers.google.com/workspace/extend):

    repeated string required_widgets = 6;

    index

    The index of the element to return.

    returns

    The requiredWidgets at the given index.

  24. abstract def getRequiredWidgetsBytes(index: Int): ByteString

    Optional. Fill this list with the names of widgets that this Action
needs for a valid submission.

If the widgets listed here don't have a value when this Action is invoked,
the form submission is aborted.

[Google Workspace add-ons and Chat
apps](https://developers.google.com/workspace/extend):


    Optional. Fill this list with the names of widgets that this Action
needs for a valid submission.

If the widgets listed here don't have a value when this Action is invoked,
the form submission is aborted.

[Google Workspace add-ons and Chat
apps](https://developers.google.com/workspace/extend):

    repeated string required_widgets = 6;

    index

    The index of the value to return.

    returns

    The bytes of the requiredWidgets at the given index.

  25. abstract def getRequiredWidgetsCount(): Int

    Optional. Fill this list with the names of widgets that this Action
needs for a valid submission.

If the widgets listed here don't have a value when this Action is invoked,
the form submission is aborted.

[Google Workspace add-ons and Chat
apps](https://developers.google.com/workspace/extend):


    Optional. Fill this list with the names of widgets that this Action
needs for a valid submission.

If the widgets listed here don't have a value when this Action is invoked,
the form submission is aborted.

[Google Workspace add-ons and Chat
apps](https://developers.google.com/workspace/extend):

    repeated string required_widgets = 6;

    returns

    The count of requiredWidgets.

  26. abstract def getRequiredWidgetsList(): List[String]

    Optional. Fill this list with the names of widgets that this Action
needs for a valid submission.

If the widgets listed here don't have a value when this Action is invoked,
the form submission is aborted.

[Google Workspace add-ons and Chat
apps](https://developers.google.com/workspace/extend):


    Optional. Fill this list with the names of widgets that this Action
needs for a valid submission.

If the widgets listed here don't have a value when this Action is invoked,
the form submission is aborted.

[Google Workspace add-ons and Chat
apps](https://developers.google.com/workspace/extend):

    repeated string required_widgets = 6;

    returns

    A list containing the requiredWidgets.

  27. abstract def getUnknownFields(): UnknownFieldSet
    Definition Classes
    MessageOrBuilder
  28. abstract def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  29. abstract def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  30. abstract def isInitialized(): Boolean
    Definition Classes
    MessageLiteOrBuilder

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from MessageOrBuilder

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped