Package com.google.apps.card.v1

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

    Modifier and Type
    Method
    Description
    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()
    Optional.
    ColorOrBuilder
    getColorOrBuilder()
    Optional.
    boolean
    getDisabled()
    If `true`, the button is displayed in an inactive state and doesn't respond to user actions.
    Icon
    getIcon()
    An icon displayed inside the button.
    IconOrBuilder
    getIconOrBuilder()
    An icon displayed inside the button.
    OnClick
    getOnClick()
    Required.
    OnClickOrBuilder
    getOnClickOrBuilder()
    Required.
    String
    getText()
    The text displayed inside the button.
    com.google.protobuf.ByteString
    getTextBytes()
    The text displayed inside the button.
    Button.Type
    getType()
    Optional.
    int
    getTypeValue()
    Optional.
    boolean
    hasColor()
    Optional.
    boolean
    hasIcon()
    An icon displayed inside the button.
    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 Details

    • getText

      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()
       An icon displayed inside the button. 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()
       An icon displayed inside the button. 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()
       An icon displayed inside the button. If both `icon` and `text` are set,
 then the icon appears before the text.
      .google.apps.card.v1.Icon icon = 2;

    • hasColor

      boolean hasColor()
       Optional. The color of the button. If set, the button `type` is set to
 `FILLED` and the color of `text` and `icon` fields are set to a
 contrasting color for readability. For example, if the button color is
 set to blue, any text or icons in the button are set to white.

 To set the button color, specify a value for the `red`, `green`, and `blue`
 fields.
 The value must be a float number between 0 and 1 based on the RGB color
 value, where `0` (0/255) represents the absence of color  and `1` (255/255)
 represents the maximum intensity of the color.

 For example, the following sets the color to red at its maximum intensity:

 ```
 "color": {
    "red": 1,
    "green": 0,
    "blue": 0,
 }
 ```

 The `alpha` field is unavailable for button color. If specified, this field
 is ignored.
      .google.type.Color color = 3;
      Returns:
      Whether the color field is set.

    • getColor

      Color getColor()
       Optional. The color of the button. If set, the button `type` is set to
 `FILLED` and the color of `text` and `icon` fields are set to a
 contrasting color for readability. For example, if the button color is
 set to blue, any text or icons in the button are set to white.

 To set the button color, specify a value for the `red`, `green`, and `blue`
 fields.
 The value must be a float number between 0 and 1 based on the RGB color
 value, where `0` (0/255) represents the absence of color  and `1` (255/255)
 represents the maximum intensity of the color.

 For example, the following sets the color to red at its maximum intensity:

 ```
 "color": {
    "red": 1,
    "green": 0,
    "blue": 0,
 }
 ```

 The `alpha` field is unavailable for button color. If specified, this field
 is ignored.
      .google.type.Color color = 3;
      Returns:
      The color.

    • getColorOrBuilder

      ColorOrBuilder getColorOrBuilder()
       Optional. The color of the button. If set, the button `type` is set to
 `FILLED` and the color of `text` and `icon` fields are set to a
 contrasting color for readability. For example, if the button color is
 set to blue, any text or icons in the button are set to white.

 To set the button color, specify a value for the `red`, `green`, and `blue`
 fields.
 The value must be a float number between 0 and 1 based on the RGB color
 value, where `0` (0/255) represents the absence of color  and `1` (255/255)
 represents the maximum intensity of the color.

 For example, the following sets the color to red at its maximum intensity:

 ```
 "color": {
    "red": 1,
    "green": 0,
    "blue": 0,
 }
 ```

 The `alpha` field is unavailable for button color. If specified, this field
 is ignored.
      .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

      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.

    • getTypeValue

      int getTypeValue()
       Optional. The type of a button. If unset, button type defaults to
 `OUTLINED`. If the `color` field is set, the button type is forced to
 `FILLED` and any value set for this field is ignored.
      .google.apps.card.v1.Button.Type type = 7;
      Returns:
      The enum numeric value on the wire for type.

    • getType

      Button.Type getType()
       Optional. The type of a button. If unset, button type defaults to
 `OUTLINED`. If the `color` field is set, the button type is forced to
 `FILLED` and any value set for this field is ignored.
      .google.apps.card.v1.Button.Type type = 7;
      Returns:
      The type.