Interface ButtonOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Button, Button.Builder

    public interface ButtonOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getAltText()
      The alternative text that's used for accessibility.
      com.google.protobuf.ByteString getAltTextBytes()
      The alternative text that's used for accessibility.
      Color getColor()
      If set, the button is filled with a solid background color and the font color changes to maintain contrast with the background color.
      ColorOrBuilder getColorOrBuilder()
      If set, the button is filled with a solid background color and the font color changes to maintain contrast with the background color.
      boolean getDisabled()
      If `true`, the button is displayed in an inactive state and doesn't respond to user actions.
      Icon getIcon()
      The icon image.
      IconOrBuilder getIconOrBuilder()
      The icon image.
      OnClick getOnClick()
      Required.
      OnClickOrBuilder getOnClickOrBuilder()
      Required.
      java.lang.String getText()
      The text displayed inside the button.
      com.google.protobuf.ByteString getTextBytes()
      The text displayed inside the button.
      boolean hasColor()
      If set, the button is filled with a solid background color and the font color changes to maintain contrast with the background color.
      boolean hasIcon()
      The icon image.
      boolean hasOnClick()
      Required.
      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Method Detail

      • getText

        java.lang.String getText()
         The text displayed inside the button.
         
        string text = 1;
        Returns:
        The text.
      • getTextBytes

        com.google.protobuf.ByteString getTextBytes()
         The text displayed inside the button.
         
        string text = 1;
        Returns:
        The bytes for text.
      • hasIcon

        boolean hasIcon()
         The icon image. If both `icon` and `text` are set, then the icon appears
         before the text.
         
        .google.apps.card.v1.Icon icon = 2;
        Returns:
        Whether the icon field is set.
      • getIcon

        Icon getIcon()
         The icon image. If both `icon` and `text` are set, then the icon appears
         before the text.
         
        .google.apps.card.v1.Icon icon = 2;
        Returns:
        The icon.
      • getIconOrBuilder

        IconOrBuilder getIconOrBuilder()
         The icon image. If both `icon` and `text` are set, then the icon appears
         before the text.
         
        .google.apps.card.v1.Icon icon = 2;
      • hasColor

        boolean hasColor()
         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
         }
         ```
         
        .google.type.Color color = 3;
        Returns:
        Whether the color field is set.
      • getColor

        Color getColor()
         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
         }
         ```
         
        .google.type.Color color = 3;
        Returns:
        The color.
      • getColorOrBuilder

        ColorOrBuilder getColorOrBuilder()
         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
         }
         ```
         
        .google.type.Color color = 3;
      • hasOnClick

        boolean hasOnClick()
         Required. The action to perform when a user clicks the button, such as
         opening a hyperlink or running a custom function.
         
        .google.apps.card.v1.OnClick on_click = 4;
        Returns:
        Whether the onClick field is set.
      • getOnClick

        OnClick getOnClick()
         Required. The action to perform when a user clicks the button, such as
         opening a hyperlink or running a custom function.
         
        .google.apps.card.v1.OnClick on_click = 4;
        Returns:
        The onClick.
      • getOnClickOrBuilder

        OnClickOrBuilder getOnClickOrBuilder()
         Required. The action to perform when a user clicks the button, such as
         opening a hyperlink or running a custom function.
         
        .google.apps.card.v1.OnClick on_click = 4;
      • getDisabled

        boolean getDisabled()
         If `true`, the button is displayed in an inactive state and doesn't respond
         to user actions.
         
        bool disabled = 5;
        Returns:
        The disabled.
      • getAltText

        java.lang.String getAltText()
         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".
         
        string alt_text = 6;
        Returns:
        The altText.
      • getAltTextBytes

        com.google.protobuf.ByteString getAltTextBytes()
         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".
         
        string alt_text = 6;
        Returns:
        The bytes for altText.