Console
    Contact Us Start free

    Google Chat V1 API - Class Google::Apps::Card::V1::Button (v0.15.0)

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

    A text, icon, or text and icon button that users can click. For an example in Google Chat apps, see Add a button .

    To make an image a clickable button, specify an Image (not an ImageComponent ) and set an onClick action.

    Google Workspace Add-ons and Chat apps :

    Inherits

    • Object

    Extended By

    • Google::Protobuf::MessageExts::ClassMethods

    Includes

    • Google::Protobuf::MessageExts

    Methods

    #alt_text

      def 
  
 alt_text 
 () 
  
 - 
>  
 :: 
 String
    Returns
    • (::String) — The alternative text that's used for accessibility.

      Set descriptive text that lets users know what the button does. For example, if a button opens a hyperlink, you might write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat".

    #alt_text=

      def 
  
 alt_text= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 String
    Parameter
    • value(::String) — The alternative text that's used for accessibility.

      Set descriptive text that lets users know what the button does. For example, if a button opens a hyperlink, you might write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat".

    Returns
    • (::String) — The alternative text that's used for accessibility.

      Set descriptive text that lets users know what the button does. For example, if a button opens a hyperlink, you might write: "Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat".

    #color

      def 
  
 color 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Type 
 :: 
 Color
    Returns
    • ( ::Google::Type::Color ) — If set, the button is filled with a solid background color and the font color changes to maintain contrast with the background color. For example, setting a blue background likely results in white text.

      If unset, the image background is white and the font color is blue.

      For red, green, and blue, the value of each field is a float number that you can express in either of two ways: as a number between 0 and 255 divided by 255 (153/255), or as a value between 0 and 1 (0.6). 0 represents the absence of a color and 1 or 255/255 represent the full presence of that color on the RGB scale.

      Optionally set alpha , which sets a level of transparency using this equation:

      pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

      For alpha , a value of 1 corresponds with a solid color, and a value of 0 corresponds with a completely transparent color.

      For example, the following color represents a half transparent red:

      "color": { "red": 1, "green": 0, "blue": 0, "alpha": 0.5 }

    #color=

      def 
  
 color= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Google 
 :: 
 Type 
 :: 
 Color
    Parameter
    • value( ::Google::Type::Color ) — If set, the button is filled with a solid background color and the font color changes to maintain contrast with the background color. For example, setting a blue background likely results in white text.

      If unset, the image background is white and the font color is blue.

      For red, green, and blue, the value of each field is a float number that you can express in either of two ways: as a number between 0 and 255 divided by 255 (153/255), or as a value between 0 and 1 (0.6). 0 represents the absence of a color and 1 or 255/255 represent the full presence of that color on the RGB scale.

      Optionally set alpha , which sets a level of transparency using this equation:

      pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

      For alpha , a value of 1 corresponds with a solid color, and a value of 0 corresponds with a completely transparent color.

      For example, the following color represents a half transparent red:

      "color": { "red": 1, "green": 0, "blue": 0, "alpha": 0.5 }

    Returns
    • ( ::Google::Type::Color ) — If set, the button is filled with a solid background color and the font color changes to maintain contrast with the background color. For example, setting a blue background likely results in white text.

      If unset, the image background is white and the font color is blue.

      For red, green, and blue, the value of each field is a float number that you can express in either of two ways: as a number between 0 and 255 divided by 255 (153/255), or as a value between 0 and 1 (0.6). 0 represents the absence of a color and 1 or 255/255 represent the full presence of that color on the RGB scale.

      Optionally set alpha , which sets a level of transparency using this equation:

      pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

      For alpha , a value of 1 corresponds with a solid color, and a value of 0 corresponds with a completely transparent color.

      For example, the following color represents a half transparent red:

      "color": { "red": 1, "green": 0, "blue": 0, "alpha": 0.5 }

    #disabled

      def 
  
 disabled 
 () 
  
 - 
>  
 :: 
 Boolean
    Returns
    • (::Boolean) — If true , the button is displayed in an inactive state and doesn't respond to user actions.

    #disabled=

      def 
  
 disabled= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Boolean
    Parameter
    • value(::Boolean) — If true , the button is displayed in an inactive state and doesn't respond to user actions.
    Returns
    • (::Boolean) — If true , the button is displayed in an inactive state and doesn't respond to user actions.

    #icon

      def 
  
 icon 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Card 
 :: 
 V1 
 :: 
 Icon
    Returns

    #icon=

      def 
  
 icon= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Card 
 :: 
 V1 
 :: 
 Icon
    Parameter
    Returns

    #on_click

      def 
  
 on_click 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Card 
 :: 
 V1 
 :: 
 OnClick
    Returns

    #on_click=

      def 
  
 on_click= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Google 
 :: 
 Apps 
 :: 
 Card 
 :: 
 V1 
 :: 
 OnClick
    Parameter
    • value( ::Google::Apps::Card::V1::OnClick ) — Required. The action to perform when a user clicks the button, such as opening a hyperlink or running a custom function.
    Returns

    #text

      def 
  
 text 
 () 
  
 - 
>  
 :: 
 String
    Returns
    • (::String) — The text displayed inside the button.

    #text=

      def 
  
 text= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 String
    Parameter
    • value(::String) — The text displayed inside the button.
    Returns
    • (::String) — The text displayed inside the button.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: