Google Chat V1 API - Class Google::Apps::Chat::V1::WidgetMarkup::KeyValue (v0.8.0)

Reference documentation and code samples for the Google Chat V1 API class Google::Apps::Chat::V1::WidgetMarkup::KeyValue.

A UI element contains a key (label) and a value (content). This element can also contain some actions such as onclick button.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#bottom_label

def bottom_label() -> ::String

Returns

(::String) — The text of the bottom label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

#bottom_label=

def bottom_label=(value) -> ::String

Parameter

value (::String) — The text of the bottom label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

Returns

(::String) — The text of the bottom label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

#button

def button() -> ::Google::Apps::Chat::V1::WidgetMarkup::Button

Returns

(::Google::Apps::Chat::V1::WidgetMarkup::Button) — A button that can be clicked to trigger an action.

#button=

def button=(value) -> ::Google::Apps::Chat::V1::WidgetMarkup::Button

Parameter

value (::Google::Apps::Chat::V1::WidgetMarkup::Button) — A button that can be clicked to trigger an action.

Returns

(::Google::Apps::Chat::V1::WidgetMarkup::Button) — A button that can be clicked to trigger an action.

#content

def content() -> ::String

Returns

(::String) — The text of the content. Formatted text supported and always required. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

#content=

def content=(value) -> ::String

Parameter

value (::String) — The text of the content. Formatted text supported and always required. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

Returns

(::String) — The text of the content. Formatted text supported and always required. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

#content_multiline

def content_multiline() -> ::Boolean

Returns

(::Boolean) — If the content should be multiline.

#content_multiline=

def content_multiline=(value) -> ::Boolean

Parameter

value (::Boolean) — If the content should be multiline.

Returns

(::Boolean) — If the content should be multiline.

#icon

def icon() -> ::Google::Apps::Chat::V1::WidgetMarkup::Icon

Returns

(::Google::Apps::Chat::V1::WidgetMarkup::Icon) — An enum value that's replaced by the Chat API with the corresponding icon image.

Note: The following fields are mutually exclusive: icon, icon_url. If a field in that set is populated, all other fields in the set will automatically be cleared.

#icon=

def icon=(value) -> ::Google::Apps::Chat::V1::WidgetMarkup::Icon

Parameter

value (::Google::Apps::Chat::V1::WidgetMarkup::Icon) — An enum value that's replaced by the Chat API with the corresponding icon image.

Note: The following fields are mutually exclusive: icon, icon_url. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Apps::Chat::V1::WidgetMarkup::Icon) — An enum value that's replaced by the Chat API with the corresponding icon image.

Note: The following fields are mutually exclusive: icon, icon_url. If a field in that set is populated, all other fields in the set will automatically be cleared.

#icon_url

def icon_url() -> ::String

Returns

(::String) — The icon specified by a URL.

Note: The following fields are mutually exclusive: icon_url, icon. If a field in that set is populated, all other fields in the set will automatically be cleared.

#icon_url=

def icon_url=(value) -> ::String

Parameter

value (::String) — The icon specified by a URL.

Note: The following fields are mutually exclusive: icon_url, icon. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::String) — The icon specified by a URL.

Note: The following fields are mutually exclusive: icon_url, icon. If a field in that set is populated, all other fields in the set will automatically be cleared.

#on_click

def on_click() -> ::Google::Apps::Chat::V1::WidgetMarkup::OnClick

Returns

(::Google::Apps::Chat::V1::WidgetMarkup::OnClick) — The onclick action. Only the top label, bottom label, and content region are clickable.

#on_click=

def on_click=(value) -> ::Google::Apps::Chat::V1::WidgetMarkup::OnClick

Parameter

value (::Google::Apps::Chat::V1::WidgetMarkup::OnClick) — The onclick action. Only the top label, bottom label, and content region are clickable.

Returns

(::Google::Apps::Chat::V1::WidgetMarkup::OnClick) — The onclick action. Only the top label, bottom label, and content region are clickable.

#top_label

def top_label() -> ::String

Returns

(::String) — The text of the top label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

#top_label=

def top_label=(value) -> ::String

Parameter

value (::String) — The text of the top label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.

Returns

(::String) — The text of the top label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons.