Console
    Contact Us Start free

    Google Chat V1 API - Class Google::Apps::Card::V1::Action (v0.11.1)

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

    An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server.

    Google Workspace Add-ons and Chat apps :

    Inherits

    • Object

    Extended By

    • Google::Protobuf::MessageExts::ClassMethods

    Includes

    • Google::Protobuf::MessageExts

    Methods

    #function

      def 
  
 function 
 () 
  
 - 
>  
 :: 
 String
    Returns
    • (::String) — A custom function to invoke when the containing element is clicked or othrwise activated.

      For example usage, see Read form data .

    #function=

      def 
  
 function= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 String
    Parameter
    • value(::String) — A custom function to invoke when the containing element is clicked or othrwise activated.

      For example usage, see Read form data .

    Returns
    • (::String) — A custom function to invoke when the containing element is clicked or othrwise activated.

      For example usage, see Read form data .

    #interaction

      def 
  
 interaction 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Card 
 :: 
 V1 
 :: 
 Action 
 :: 
 Interaction
    Returns
    • ( ::Google::Apps::Card::V1::Action::Interaction ) — Optional. Required when opening a dialog .

      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 . 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 :

    #interaction=

      def 
  
 interaction= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Card 
 :: 
 V1 
 :: 
 Action 
 :: 
 Interaction
    Parameter
    • value( ::Google::Apps::Card::V1::Action::Interaction ) — Optional. Required when opening a dialog .

      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 . 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 :

    Returns
    • ( ::Google::Apps::Card::V1::Action::Interaction ) — Optional. Required when opening a dialog .

      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 . 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 :

    #load_indicator

      def 
  
 load_indicator 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Card 
 :: 
 V1 
 :: 
 Action 
 :: 
 LoadIndicator
    Returns

    #load_indicator=

      def 
  
 load_indicator= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Card 
 :: 
 V1 
 :: 
 Action 
 :: 
 LoadIndicator
    Parameter
    Returns

    #parameters

      def 
  
 parameters 
 () 
  
 - 
>  
 :: 
 Array 
< :: 
 Google 
 :: 
 Apps 
 :: 
 Card 
 :: 
 V1 
 :: 
 Action 
 :: 
 ActionParameter 
>
    Returns

    #parameters=

      def 
  
 parameters= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Array 
< :: 
 Google 
 :: 
 Apps 
 :: 
 Card 
 :: 
 V1 
 :: 
 Action 
 :: 
 ActionParameter 
>
    Parameter
    Returns

    #persist_values

      def 
  
 persist_values 
 () 
  
 - 
>  
 :: 
 Boolean
    Returns
    • (::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 to NONE . For card messages in Chat apps, you must also set the action's ResponseType to UPDATE_MESSAGE and use the same card_id 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 to SPINNER .

    #persist_values=

      def 
  
 persist_values= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Boolean
    Parameter
    • value(::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 to NONE . For card messages in Chat apps, you must also set the action's ResponseType to UPDATE_MESSAGE and use the same card_id 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 to SPINNER .

    Returns
    • (::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 to NONE . For card messages in Chat apps, you must also set the action's ResponseType to UPDATE_MESSAGE and use the same card_id 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 to SPINNER .
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: