Console
    Start free

    Google Chat V1 API - Class Google::Apps::Card::V1::TextInput (v0.5.1)

    Reference documentation and code samples for the Google Chat V1 API class Google::Apps::Card::V1::TextInput.

    A field in which users can enter text. Supports suggestions and on-change actions. For an example in Google Chat apps, see Add a field in which a user can enter text .

    Chat apps receive and can process the value of entered text during form input events. For details about working with form inputs, see Receive form data .

    When you need to collect undefined or abstract data from users, use a text input. To collect defined or enumerated data from users, use the SelectionInput widget.

    Google Workspace Add-ons and Chat apps :

    Inherits

    • Object

    Extended By

    • Google::Protobuf::MessageExts::ClassMethods

    Includes

    • Google::Protobuf::MessageExts

    Methods

    #auto_complete_action

      def 
  
 auto_complete_action 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Card 
 :: 
 V1 
 :: 
 Action
    Returns
    • ( ::Google::Apps::Card::V1::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 :

    #auto_complete_action=

      def 
  
 auto_complete_action= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Card 
 :: 
 V1 
 :: 
 Action
    Parameter
    • value( ::Google::Apps::Card::V1::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 :

    Returns
    • ( ::Google::Apps::Card::V1::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 :

    #hint_text

      def 
  
 hint_text 
 () 
  
 - 
>  
 :: 
 String
    Returns
    • (::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.

    #hint_text=

      def 
  
 hint_text= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 String
    Parameter
    • value(::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.

    Returns
    • (::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.

    #initial_suggestions

      def 
  
 initial_suggestions 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Card 
 :: 
 V1 
 :: 
 Suggestions
    Returns
    • ( ::Google::Apps::Card::V1::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 :

    #initial_suggestions=

      def 
  
 initial_suggestions= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Card 
 :: 
 V1 
 :: 
 Suggestions
    Parameter
    • value( ::Google::Apps::Card::V1::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 :

    Returns
    • ( ::Google::Apps::Card::V1::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 :

    #label

      def 
  
 label 
 () 
  
 - 
>  
 :: 
 String
    Returns
    • (::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.

    #label=

      def 
  
 label= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 String
    Parameter
    • value(::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.

    Returns
    • (::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.

    #name

      def 
  
 name 
 () 
  
 - 
>  
 :: 
 String
    Returns
    • (::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 .

    #name=

      def 
  
 name= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 String
    Parameter
    • value(::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 .

    Returns
    • (::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 .

    #on_change_action

      def 
  
 on_change_action 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Card 
 :: 
 V1 
 :: 
 Action
    Returns
    • ( ::Google::Apps::Card::V1::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 in Google Chat.

    #on_change_action=

      def 
  
 on_change_action= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Card 
 :: 
 V1 
 :: 
 Action
    Parameter
    • value( ::Google::Apps::Card::V1::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 in Google Chat.

    Returns
    • ( ::Google::Apps::Card::V1::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 in Google Chat.

    #placeholder_text

      def 
  
 placeholder_text 
 () 
  
 - 
>  
 :: 
 String
    Returns
    • (::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 :

    #placeholder_text=

      def 
  
 placeholder_text= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 String
    Parameter
    • value(::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 :

    Returns
    • (::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 :

    #type

      def 
  
 type 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Card 
 :: 
 V1 
 :: 
 TextInput 
 :: 
 Type
    Returns

    #type=

      def 
  
 type= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Card 
 :: 
 V1 
 :: 
 TextInput 
 :: 
 Type
    Parameter
    Returns

    #value

      def 
  
 value 
 () 
  
 - 
>  
 :: 
 String
    Returns
    • (::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 .

    #value=

      def 
  
 value= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 String
    Parameter
    • value(::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 .

    Returns
    • (::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 .
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: