Package com.google.apps.card.v1

Class Button.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Button.Builder>
com.google.apps.card.v1.Button.Builder
All Implemented Interfaces:
ButtonOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Button
public static final class Button.Builder extends com.google.protobuf.GeneratedMessage.Builder<Button.Builder> implements ButtonOrBuilder
 A text, icon, or text and icon button that users can click. For an example in
 Google Chat apps, see
 [Add a
 button](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button).

 To make an image a clickable button, specify an
 [`Image`][google.apps.card.v1.Image] (not an
 [`ImageComponent`][google.apps.card.v1.ImageComponent]) and set an
 `onClick` action.

 [Google Workspace
 add-ons and Chat apps](https://developers.google.com/workspace/extend):
Protobuf type google.apps.card.v1.Button

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Button.Builder>

    • clear

      public Button.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<Button.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Button.Builder>

    • getDefaultInstanceForType

      public Button getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public Button build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public Button buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public Button.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Button.Builder>

    • mergeFrom

      public Button.Builder mergeFrom(Button other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Button.Builder>

    • mergeFrom

      public Button.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Button.Builder>
      Throws:
      IOException

    • getText

      public String getText()
       The text displayed inside the button.
      string text = 1;
      Specified by:
      getText in interface ButtonOrBuilder
      Returns:
      The text.

    • getTextBytes

      public com.google.protobuf.ByteString getTextBytes()
       The text displayed inside the button.
      string text = 1;
      Specified by:
      getTextBytes in interface ButtonOrBuilder
      Returns:
      The bytes for text.

    • setText

      public Button.Builder setText(String value)
       The text displayed inside the button.
      string text = 1;
      Parameters:
      value - The text to set.
      Returns:
      This builder for chaining.

    • clearText

      public Button.Builder clearText()
       The text displayed inside the button.
      string text = 1;
      Returns:
      This builder for chaining.

    • setTextBytes

      public Button.Builder setTextBytes(com.google.protobuf.ByteString value)
       The text displayed inside the button.
      string text = 1;
      Parameters:
      value - The bytes for text to set.
      Returns:
      This builder for chaining.

    • hasIcon

      public 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;
      Specified by:
      hasIcon in interface ButtonOrBuilder
      Returns:
      Whether the icon field is set.

    • getIcon

      public 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;
      Specified by:
      getIcon in interface ButtonOrBuilder
      Returns:
      The icon.

    • setIcon

      public Button.Builder setIcon(Icon value)
       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;

    • setIcon

      public Button.Builder setIcon(Icon.Builder builderForValue)
       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;

    • mergeIcon

      public Button.Builder mergeIcon(Icon value)
       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;

    • clearIcon

      public Button.Builder clearIcon()
       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;

    • getIconBuilder

      public Icon.Builder getIconBuilder()
       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;

    • getIconOrBuilder

      public 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;
      Specified by:
      getIconOrBuilder in interface ButtonOrBuilder

    • hasColor

      public 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;
      Specified by:
      hasColor in interface ButtonOrBuilder
      Returns:
      Whether the color field is set.

    • getColor

      public 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;
      Specified by:
      getColor in interface ButtonOrBuilder
      Returns:
      The color.

    • setColor

      public Button.Builder setColor(Color value)
       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;

    • setColor

      public Button.Builder setColor(Color.Builder builderForValue)
       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;

    • mergeColor

      public Button.Builder mergeColor(Color value)
       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;

    • clearColor

      public Button.Builder clearColor()
       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;

    • getColorBuilder

      public Color.Builder getColorBuilder()
       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;

    • getColorOrBuilder

      public 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;
      Specified by:
      getColorOrBuilder in interface ButtonOrBuilder

    • hasOnClick

      public 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;
      Specified by:
      hasOnClick in interface ButtonOrBuilder
      Returns:
      Whether the onClick field is set.

    • getOnClick

      public 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;
      Specified by:
      getOnClick in interface ButtonOrBuilder
      Returns:
      The onClick.

    • setOnClick

      public Button.Builder setOnClick(OnClick value)
       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;

    • setOnClick

      public Button.Builder setOnClick(OnClick.Builder builderForValue)
       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;

    • mergeOnClick

      public Button.Builder mergeOnClick(OnClick value)
       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;

    • clearOnClick

      public Button.Builder clearOnClick()
       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;

    • getOnClickBuilder

      public OnClick.Builder getOnClickBuilder()
       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;

    • getOnClickOrBuilder

      public 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;
      Specified by:
      getOnClickOrBuilder in interface ButtonOrBuilder

    • getDisabled

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

    • setDisabled

      public Button.Builder setDisabled(boolean value)
       If `true`, the button is displayed in an inactive state and doesn't respond
 to user actions.
      bool disabled = 5;
      Parameters:
      value - The disabled to set.
      Returns:
      This builder for chaining.

    • clearDisabled

      public Button.Builder clearDisabled()
       If `true`, the button is displayed in an inactive state and doesn't respond
 to user actions.
      bool disabled = 5;
      Returns:
      This builder for chaining.

    • getAltText

      public 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;
      Specified by:
      getAltText in interface ButtonOrBuilder
      Returns:
      The altText.

    • getAltTextBytes

      public 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;
      Specified by:
      getAltTextBytes in interface ButtonOrBuilder
      Returns:
      The bytes for altText.

    • setAltText

      public Button.Builder setAltText(String value)
       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;
      Parameters:
      value - The altText to set.
      Returns:
      This builder for chaining.

    • clearAltText

      public Button.Builder clearAltText()
       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:
      This builder for chaining.

    • setAltTextBytes

      public Button.Builder setAltTextBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for altText to set.
      Returns:
      This builder for chaining.

    • getTypeValue

      public 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;
      Specified by:
      getTypeValue in interface ButtonOrBuilder
      Returns:
      The enum numeric value on the wire for type.

    • setTypeValue

      public Button.Builder setTypeValue(int value)
       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;
      Parameters:
      value - The enum numeric value on the wire for type to set.
      Returns:
      This builder for chaining.

    • getType

      public 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;
      Specified by:
      getType in interface ButtonOrBuilder
      Returns:
      The type.

    • setType

      public Button.Builder setType(Button.Type value)
       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;
      Parameters:
      value - The type to set.
      Returns:
      This builder for chaining.

    • clearType

      public Button.Builder clearType()
       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:
      This builder for chaining.