t

com.google.apps.card.v1

TextInputOrBuilder

trait TextInputOrBuilder extends MessageOrBuilder

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TextInputOrBuilder
  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 getAutoCompleteAction(): Action

    Optional. Specify what action to take when the text input field provides
suggestions to users who interact with it.

If unspecified, the suggestions are set by `initialSuggestions` and
are processed by the client.

If specified, the app takes the action specified here, such as running
a custom function.

[Google Workspace
Add-ons](https://developers.google.com/workspace/add-ons):


    Optional. Specify what action to take when the text input field provides
suggestions to users who interact with it.

If unspecified, the suggestions are set by `initialSuggestions` and
are processed by the client.

If specified, the app takes the action specified here, such as running
a custom function.

[Google Workspace
Add-ons](https://developers.google.com/workspace/add-ons):

    .google.apps.card.v1.Action auto_complete_action = 8;

    returns

    The autoCompleteAction.

  4. abstract def getAutoCompleteActionOrBuilder(): ActionOrBuilder

    Optional. Specify what action to take when the text input field provides
suggestions to users who interact with it.

If unspecified, the suggestions are set by `initialSuggestions` and
are processed by the client.

If specified, the app takes the action specified here, such as running
a custom function.

[Google Workspace
Add-ons](https://developers.google.com/workspace/add-ons):


    Optional. Specify what action to take when the text input field provides
suggestions to users who interact with it.

If unspecified, the suggestions are set by `initialSuggestions` and
are processed by the client.

If specified, the app takes the action specified here, such as running
a custom function.

[Google Workspace
Add-ons](https://developers.google.com/workspace/add-ons):

    .google.apps.card.v1.Action auto_complete_action = 8;

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

    Text that appears below the text input field meant to assist users by
prompting them to enter a certain value. This text is always visible.

Required if `label` is unspecified. Otherwise, optional.


    Text that appears below the text input field meant to assist users by
prompting them to enter a certain value. This text is always visible.

Required if `label` is unspecified. Otherwise, optional.

    string hint_text = 3;

    returns

    The hintText.

  9. abstract def getHintTextBytes(): ByteString

    Text that appears below the text input field meant to assist users by
prompting them to enter a certain value. This text is always visible.

Required if `label` is unspecified. Otherwise, optional.


    Text that appears below the text input field meant to assist users by
prompting them to enter a certain value. This text is always visible.

Required if `label` is unspecified. Otherwise, optional.

    string hint_text = 3;

    returns

    The bytes for hintText.

  10. abstract def getInitialSuggestions(): Suggestions

    Suggested values that users can enter. These values appear when users click
inside the text input field. As users type, the suggested values
dynamically filter to match what the users have typed.

For example, a text input field for programming language might suggest
Java, JavaScript, Python, and C++. When users start typing `Jav`, the list
of suggestions filters to show just `Java` and `JavaScript`.

Suggested values help guide users to enter values that your app can make
sense of. When referring to JavaScript, some users might enter `javascript`
and others `java script`. Suggesting `JavaScript` can standardize how users
interact with your app.

When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set
to `MULTIPLE_LINE`.

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


    Suggested values that users can enter. These values appear when users click
inside the text input field. As users type, the suggested values
dynamically filter to match what the users have typed.

For example, a text input field for programming language might suggest
Java, JavaScript, Python, and C++. When users start typing `Jav`, the list
of suggestions filters to show just `Java` and `JavaScript`.

Suggested values help guide users to enter values that your app can make
sense of. When referring to JavaScript, some users might enter `javascript`
and others `java script`. Suggesting `JavaScript` can standardize how users
interact with your app.

When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set
to `MULTIPLE_LINE`.

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

    .google.apps.card.v1.Suggestions initial_suggestions = 7;

    returns

    The initialSuggestions.

  11. abstract def getInitialSuggestionsOrBuilder(): SuggestionsOrBuilder

    Suggested values that users can enter. These values appear when users click
inside the text input field. As users type, the suggested values
dynamically filter to match what the users have typed.

For example, a text input field for programming language might suggest
Java, JavaScript, Python, and C++. When users start typing `Jav`, the list
of suggestions filters to show just `Java` and `JavaScript`.

Suggested values help guide users to enter values that your app can make
sense of. When referring to JavaScript, some users might enter `javascript`
and others `java script`. Suggesting `JavaScript` can standardize how users
interact with your app.

When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set
to `MULTIPLE_LINE`.

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


    Suggested values that users can enter. These values appear when users click
inside the text input field. As users type, the suggested values
dynamically filter to match what the users have typed.

For example, a text input field for programming language might suggest
Java, JavaScript, Python, and C++. When users start typing `Jav`, the list
of suggestions filters to show just `Java` and `JavaScript`.

Suggested values help guide users to enter values that your app can make
sense of. When referring to JavaScript, some users might enter `javascript`
and others `java script`. Suggesting `JavaScript` can standardize how users
interact with your app.

When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set
to `MULTIPLE_LINE`.

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

    .google.apps.card.v1.Suggestions initial_suggestions = 7;

  12. abstract def getInitializationErrorString(): String
    Definition Classes
    MessageOrBuilder
  13. abstract def getLabel(): String

    The text that appears above the text input field in the user interface.

Specify text that helps the user enter the information your app needs.
For example, if you are asking someone's name, but specifically need their
surname, write `surname` instead of `name`.

Required if `hintText` is unspecified. Otherwise, optional.


    The text that appears above the text input field in the user interface.

Specify text that helps the user enter the information your app needs.
For example, if you are asking someone's name, but specifically need their
surname, write `surname` instead of `name`.

Required if `hintText` is unspecified. Otherwise, optional.

    string label = 2;

    returns

    The label.

  14. abstract def getLabelBytes(): ByteString

    The text that appears above the text input field in the user interface.

Specify text that helps the user enter the information your app needs.
For example, if you are asking someone's name, but specifically need their
surname, write `surname` instead of `name`.

Required if `hintText` is unspecified. Otherwise, optional.


    The text that appears above the text input field in the user interface.

Specify text that helps the user enter the information your app needs.
For example, if you are asking someone's name, but specifically need their
surname, write `surname` instead of `name`.

Required if `hintText` is unspecified. Otherwise, optional.

    string label = 2;

    returns

    The bytes for label.

  15. abstract def getName(): String

    The name by which the text input is identified in a form input event.

For details about working with form inputs, see [Receive form
data](https://developers.google.com/workspace/chat/read-form-data).


    The name by which the text input is identified in a form input event.

For details about working with form inputs, see [Receive form
data](https://developers.google.com/workspace/chat/read-form-data).

    string name = 1;

    returns

    The name.

  16. abstract def getNameBytes(): ByteString

    The name by which the text input is identified in a form input event.

For details about working with form inputs, see [Receive form
data](https://developers.google.com/workspace/chat/read-form-data).


    The name by which the text input is identified in a form input event.

For details about working with form inputs, see [Receive form
data](https://developers.google.com/workspace/chat/read-form-data).

    string name = 1;

    returns

    The bytes for name.

  17. abstract def getOnChangeAction(): Action

    What to do when a change occurs in the text input field. For example, a
user adding to the field or deleting text.

Examples of actions to take include running a custom function or opening
a [dialog](https://developers.google.com/workspace/chat/dialogs)
in Google Chat.


    What to do when a change occurs in the text input field. For example, a
user adding to the field or deleting text.

Examples of actions to take include running a custom function or opening
a [dialog](https://developers.google.com/workspace/chat/dialogs)
in Google Chat.

    .google.apps.card.v1.Action on_change_action = 6;

    returns

    The onChangeAction.

  18. abstract def getOnChangeActionOrBuilder(): ActionOrBuilder

    What to do when a change occurs in the text input field. For example, a
user adding to the field or deleting text.

Examples of actions to take include running a custom function or opening
a [dialog](https://developers.google.com/workspace/chat/dialogs)
in Google Chat.


    What to do when a change occurs in the text input field. For example, a
user adding to the field or deleting text.

Examples of actions to take include running a custom function or opening
a [dialog](https://developers.google.com/workspace/chat/dialogs)
in Google Chat.

    .google.apps.card.v1.Action on_change_action = 6;

  19. abstract def getOneofFieldDescriptor(arg0: OneofDescriptor): FieldDescriptor
    Definition Classes
    MessageOrBuilder
  20. abstract def getPlaceholderText(): String

    Text that appears in the text input field when the field is empty.
Use this text to prompt users to enter a value. For example, `Enter a
number from 0 to 100`.

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


    Text that appears in the text input field when the field is empty.
Use this text to prompt users to enter a value. For example, `Enter a
number from 0 to 100`.

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

    string placeholder_text = 12;

    returns

    The placeholderText.

  21. abstract def getPlaceholderTextBytes(): ByteString

    Text that appears in the text input field when the field is empty.
Use this text to prompt users to enter a value. For example, `Enter a
number from 0 to 100`.

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


    Text that appears in the text input field when the field is empty.
Use this text to prompt users to enter a value. For example, `Enter a
number from 0 to 100`.

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

    string placeholder_text = 12;

    returns

    The bytes for placeholderText.

  22. abstract def getRepeatedField(arg0: FieldDescriptor, arg1: Int): AnyRef
    Definition Classes
    MessageOrBuilder
  23. abstract def getRepeatedFieldCount(arg0: FieldDescriptor): Int
    Definition Classes
    MessageOrBuilder
  24. abstract def getType(): Type

    How a text input field appears in the user interface.
For example, whether the field is single or multi-line.


    How a text input field appears in the user interface.
For example, whether the field is single or multi-line.

    .google.apps.card.v1.TextInput.Type type = 5;

    returns

    The type.

  25. abstract def getTypeValue(): Int

    How a text input field appears in the user interface.
For example, whether the field is single or multi-line.


    How a text input field appears in the user interface.
For example, whether the field is single or multi-line.

    .google.apps.card.v1.TextInput.Type type = 5;

    returns

    The enum numeric value on the wire for type.

  26. abstract def getUnknownFields(): UnknownFieldSet
    Definition Classes
    MessageOrBuilder
  27. abstract def getValue(): String

    The value entered by a user, returned as part of a form input event.

For details about working with form inputs, see [Receive form
data](https://developers.google.com/workspace/chat/read-form-data).


    The value entered by a user, returned as part of a form input event.

For details about working with form inputs, see [Receive form
data](https://developers.google.com/workspace/chat/read-form-data).

    string value = 4;

    returns

    The value.

  28. abstract def getValueBytes(): ByteString

    The value entered by a user, returned as part of a form input event.

For details about working with form inputs, see [Receive form
data](https://developers.google.com/workspace/chat/read-form-data).


    The value entered by a user, returned as part of a form input event.

For details about working with form inputs, see [Receive form
data](https://developers.google.com/workspace/chat/read-form-data).

    string value = 4;

    returns

    The bytes for value.

  29. abstract def hasAutoCompleteAction(): Boolean

    Optional. Specify what action to take when the text input field provides
suggestions to users who interact with it.

If unspecified, the suggestions are set by `initialSuggestions` and
are processed by the client.

If specified, the app takes the action specified here, such as running
a custom function.

[Google Workspace
Add-ons](https://developers.google.com/workspace/add-ons):


    Optional. Specify what action to take when the text input field provides
suggestions to users who interact with it.

If unspecified, the suggestions are set by `initialSuggestions` and
are processed by the client.

If specified, the app takes the action specified here, such as running
a custom function.

[Google Workspace
Add-ons](https://developers.google.com/workspace/add-ons):

    .google.apps.card.v1.Action auto_complete_action = 8;

    returns

    Whether the autoCompleteAction field is set.

  30. abstract def hasField(arg0: FieldDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  31. abstract def hasInitialSuggestions(): Boolean

    Suggested values that users can enter. These values appear when users click
inside the text input field. As users type, the suggested values
dynamically filter to match what the users have typed.

For example, a text input field for programming language might suggest
Java, JavaScript, Python, and C++. When users start typing `Jav`, the list
of suggestions filters to show just `Java` and `JavaScript`.

Suggested values help guide users to enter values that your app can make
sense of. When referring to JavaScript, some users might enter `javascript`
and others `java script`. Suggesting `JavaScript` can standardize how users
interact with your app.

When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set
to `MULTIPLE_LINE`.

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


    Suggested values that users can enter. These values appear when users click
inside the text input field. As users type, the suggested values
dynamically filter to match what the users have typed.

For example, a text input field for programming language might suggest
Java, JavaScript, Python, and C++. When users start typing `Jav`, the list
of suggestions filters to show just `Java` and `JavaScript`.

Suggested values help guide users to enter values that your app can make
sense of. When referring to JavaScript, some users might enter `javascript`
and others `java script`. Suggesting `JavaScript` can standardize how users
interact with your app.

When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set
to `MULTIPLE_LINE`.

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

    .google.apps.card.v1.Suggestions initial_suggestions = 7;

    returns

    Whether the initialSuggestions field is set.

  32. abstract def hasOnChangeAction(): Boolean

    What to do when a change occurs in the text input field. For example, a
user adding to the field or deleting text.

Examples of actions to take include running a custom function or opening
a [dialog](https://developers.google.com/workspace/chat/dialogs)
in Google Chat.


    What to do when a change occurs in the text input field. For example, a
user adding to the field or deleting text.

Examples of actions to take include running a custom function or opening
a [dialog](https://developers.google.com/workspace/chat/dialogs)
in Google Chat.

    .google.apps.card.v1.Action on_change_action = 6;

    returns

    Whether the onChangeAction field is set.

  33. abstract def hasOneof(arg0: OneofDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  34. 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