Documentation ¶
Index ¶
- Variables
- type Action
- func (*Action) Descriptor() ([]byte, []int)deprecated
- func (x *Action) GetFunction() string
- func (x *Action) GetInteraction() Action_Interaction
- func (x *Action) GetLoadIndicator() Action_LoadIndicator
- func (x *Action) GetParameters() []*Action_ActionParameter
- func (x *Action) GetPersistValues() bool
- func (*Action) ProtoMessage()
- func (x *Action) ProtoReflect() protoreflect.Message
- func (x *Action) Reset()
- func (x *Action) String() string
- type Action_ActionParameter
- func (*Action_ActionParameter) Descriptor() ([]byte, []int)deprecated
- func (x *Action_ActionParameter) GetKey() string
- func (x *Action_ActionParameter) GetValue() string
- func (*Action_ActionParameter) ProtoMessage()
- func (x *Action_ActionParameter) ProtoReflect() protoreflect.Message
- func (x *Action_ActionParameter) Reset()
- func (x *Action_ActionParameter) String() string
- type Action_Interaction
- func (Action_Interaction) Descriptor() protoreflect.EnumDescriptor
- func (x Action_Interaction) Enum() *Action_Interaction
- func (Action_Interaction) EnumDescriptor() ([]byte, []int)deprecated
- func (x Action_Interaction) Number() protoreflect.EnumNumber
- func (x Action_Interaction) String() string
- func (Action_Interaction) Type() protoreflect.EnumType
- type Action_LoadIndicator
- func (Action_LoadIndicator) Descriptor() protoreflect.EnumDescriptor
- func (x Action_LoadIndicator) Enum() *Action_LoadIndicator
- func (Action_LoadIndicator) EnumDescriptor() ([]byte, []int)deprecated
- func (x Action_LoadIndicator) Number() protoreflect.EnumNumber
- func (x Action_LoadIndicator) String() string
- func (Action_LoadIndicator) Type() protoreflect.EnumType
- type BorderStyle
- func (*BorderStyle) Descriptor() ([]byte, []int)deprecated
- func (x *BorderStyle) GetCornerRadius() int32
- func (x *BorderStyle) GetStrokeColor() *color.Color
- func (x *BorderStyle) GetType() BorderStyle_BorderType
- func (*BorderStyle) ProtoMessage()
- func (x *BorderStyle) ProtoReflect() protoreflect.Message
- func (x *BorderStyle) Reset()
- func (x *BorderStyle) String() string
- type BorderStyle_BorderType
- func (BorderStyle_BorderType) Descriptor() protoreflect.EnumDescriptor
- func (x BorderStyle_BorderType) Enum() *BorderStyle_BorderType
- func (BorderStyle_BorderType) EnumDescriptor() ([]byte, []int)deprecated
- func (x BorderStyle_BorderType) Number() protoreflect.EnumNumber
- func (x BorderStyle_BorderType) String() string
- func (BorderStyle_BorderType) Type() protoreflect.EnumType
- type Button
- func (*Button) Descriptor() ([]byte, []int)deprecated
- func (x *Button) GetAltText() string
- func (x *Button) GetColor() *color.Color
- func (x *Button) GetDisabled() bool
- func (x *Button) GetIcon() *Icon
- func (x *Button) GetOnClick() *OnClick
- func (x *Button) GetText() string
- func (*Button) ProtoMessage()
- func (x *Button) ProtoReflect() protoreflect.Message
- func (x *Button) Reset()
- func (x *Button) String() string
- type ButtonList
- type Card
- func (*Card) Descriptor() ([]byte, []int)deprecated
- func (x *Card) GetCardActions() []*Card_CardAction
- func (x *Card) GetDisplayStyle() Card_DisplayStyle
- func (x *Card) GetFixedFooter() *Card_CardFixedFooter
- func (x *Card) GetHeader() *Card_CardHeader
- func (x *Card) GetName() string
- func (x *Card) GetPeekCardHeader() *Card_CardHeader
- func (x *Card) GetSectionDividerStyle() Card_DividerStyle
- func (x *Card) GetSections() []*Card_Section
- func (*Card) ProtoMessage()
- func (x *Card) ProtoReflect() protoreflect.Message
- func (x *Card) Reset()
- func (x *Card) String() string
- type Card_CardAction
- func (*Card_CardAction) Descriptor() ([]byte, []int)deprecated
- func (x *Card_CardAction) GetActionLabel() string
- func (x *Card_CardAction) GetOnClick() *OnClick
- func (*Card_CardAction) ProtoMessage()
- func (x *Card_CardAction) ProtoReflect() protoreflect.Message
- func (x *Card_CardAction) Reset()
- func (x *Card_CardAction) String() string
- type Card_CardFixedFooter
- func (*Card_CardFixedFooter) Descriptor() ([]byte, []int)deprecated
- func (x *Card_CardFixedFooter) GetPrimaryButton() *Button
- func (x *Card_CardFixedFooter) GetSecondaryButton() *Button
- func (*Card_CardFixedFooter) ProtoMessage()
- func (x *Card_CardFixedFooter) ProtoReflect() protoreflect.Message
- func (x *Card_CardFixedFooter) Reset()
- func (x *Card_CardFixedFooter) String() string
- type Card_CardHeader
- func (*Card_CardHeader) Descriptor() ([]byte, []int)deprecated
- func (x *Card_CardHeader) GetImageAltText() string
- func (x *Card_CardHeader) GetImageType() Widget_ImageType
- func (x *Card_CardHeader) GetImageUrl() string
- func (x *Card_CardHeader) GetSubtitle() string
- func (x *Card_CardHeader) GetTitle() string
- func (*Card_CardHeader) ProtoMessage()
- func (x *Card_CardHeader) ProtoReflect() protoreflect.Message
- func (x *Card_CardHeader) Reset()
- func (x *Card_CardHeader) String() string
- type Card_DisplayStyle
- func (Card_DisplayStyle) Descriptor() protoreflect.EnumDescriptor
- func (x Card_DisplayStyle) Enum() *Card_DisplayStyle
- func (Card_DisplayStyle) EnumDescriptor() ([]byte, []int)deprecated
- func (x Card_DisplayStyle) Number() protoreflect.EnumNumber
- func (x Card_DisplayStyle) String() string
- func (Card_DisplayStyle) Type() protoreflect.EnumType
- type Card_DividerStyle
- func (Card_DividerStyle) Descriptor() protoreflect.EnumDescriptor
- func (x Card_DividerStyle) Enum() *Card_DividerStyle
- func (Card_DividerStyle) EnumDescriptor() ([]byte, []int)deprecated
- func (x Card_DividerStyle) Number() protoreflect.EnumNumber
- func (x Card_DividerStyle) String() string
- func (Card_DividerStyle) Type() protoreflect.EnumType
- type Card_Section
- func (*Card_Section) Descriptor() ([]byte, []int)deprecated
- func (x *Card_Section) GetCollapsible() bool
- func (x *Card_Section) GetHeader() string
- func (x *Card_Section) GetUncollapsibleWidgetsCount() int32
- func (x *Card_Section) GetWidgets() []*Widget
- func (*Card_Section) ProtoMessage()
- func (x *Card_Section) ProtoReflect() protoreflect.Message
- func (x *Card_Section) Reset()
- func (x *Card_Section) String() string
- type Columns
- type Columns_Column
- func (*Columns_Column) Descriptor() ([]byte, []int)deprecated
- func (x *Columns_Column) GetHorizontalAlignment() Widget_HorizontalAlignment
- func (x *Columns_Column) GetHorizontalSizeStyle() Columns_Column_HorizontalSizeStyle
- func (x *Columns_Column) GetVerticalAlignment() Columns_Column_VerticalAlignment
- func (x *Columns_Column) GetWidgets() []*Columns_Column_Widgets
- func (*Columns_Column) ProtoMessage()
- func (x *Columns_Column) ProtoReflect() protoreflect.Message
- func (x *Columns_Column) Reset()
- func (x *Columns_Column) String() string
- type Columns_Column_HorizontalSizeStyle
- func (Columns_Column_HorizontalSizeStyle) Descriptor() protoreflect.EnumDescriptor
- func (x Columns_Column_HorizontalSizeStyle) Enum() *Columns_Column_HorizontalSizeStyle
- func (Columns_Column_HorizontalSizeStyle) EnumDescriptor() ([]byte, []int)deprecated
- func (x Columns_Column_HorizontalSizeStyle) Number() protoreflect.EnumNumber
- func (x Columns_Column_HorizontalSizeStyle) String() string
- func (Columns_Column_HorizontalSizeStyle) Type() protoreflect.EnumType
- type Columns_Column_VerticalAlignment
- func (Columns_Column_VerticalAlignment) Descriptor() protoreflect.EnumDescriptor
- func (x Columns_Column_VerticalAlignment) Enum() *Columns_Column_VerticalAlignment
- func (Columns_Column_VerticalAlignment) EnumDescriptor() ([]byte, []int)deprecated
- func (x Columns_Column_VerticalAlignment) Number() protoreflect.EnumNumber
- func (x Columns_Column_VerticalAlignment) String() string
- func (Columns_Column_VerticalAlignment) Type() protoreflect.EnumType
- type Columns_Column_Widgets
- func (*Columns_Column_Widgets) Descriptor() ([]byte, []int)deprecated
- func (x *Columns_Column_Widgets) GetButtonList() *ButtonList
- func (m *Columns_Column_Widgets) GetData() isColumns_Column_Widgets_Data
- func (x *Columns_Column_Widgets) GetDateTimePicker() *DateTimePicker
- func (x *Columns_Column_Widgets) GetDecoratedText() *DecoratedText
- func (x *Columns_Column_Widgets) GetImage() *Image
- func (x *Columns_Column_Widgets) GetSelectionInput() *SelectionInput
- func (x *Columns_Column_Widgets) GetTextInput() *TextInput
- func (x *Columns_Column_Widgets) GetTextParagraph() *TextParagraph
- func (*Columns_Column_Widgets) ProtoMessage()
- func (x *Columns_Column_Widgets) ProtoReflect() protoreflect.Message
- func (x *Columns_Column_Widgets) Reset()
- func (x *Columns_Column_Widgets) String() string
- type Columns_Column_Widgets_ButtonList
- type Columns_Column_Widgets_DateTimePicker
- type Columns_Column_Widgets_DecoratedText
- type Columns_Column_Widgets_Image
- type Columns_Column_Widgets_SelectionInput
- type Columns_Column_Widgets_TextInput
- type Columns_Column_Widgets_TextParagraph
- type DateTimePicker
- func (*DateTimePicker) Descriptor() ([]byte, []int)deprecated
- func (x *DateTimePicker) GetLabel() string
- func (x *DateTimePicker) GetName() string
- func (x *DateTimePicker) GetOnChangeAction() *Action
- func (x *DateTimePicker) GetTimezoneOffsetDate() int32
- func (x *DateTimePicker) GetType() DateTimePicker_DateTimePickerType
- func (x *DateTimePicker) GetValueMsEpoch() int64
- func (*DateTimePicker) ProtoMessage()
- func (x *DateTimePicker) ProtoReflect() protoreflect.Message
- func (x *DateTimePicker) Reset()
- func (x *DateTimePicker) String() string
- type DateTimePicker_DateTimePickerType
- func (DateTimePicker_DateTimePickerType) Descriptor() protoreflect.EnumDescriptor
- func (x DateTimePicker_DateTimePickerType) Enum() *DateTimePicker_DateTimePickerType
- func (DateTimePicker_DateTimePickerType) EnumDescriptor() ([]byte, []int)deprecated
- func (x DateTimePicker_DateTimePickerType) Number() protoreflect.EnumNumber
- func (x DateTimePicker_DateTimePickerType) String() string
- func (DateTimePicker_DateTimePickerType) Type() protoreflect.EnumType
- type DecoratedText
- func (*DecoratedText) Descriptor() ([]byte, []int)deprecated
- func (x *DecoratedText) GetBottomLabel() string
- func (x *DecoratedText) GetButton() *Button
- func (m *DecoratedText) GetControl() isDecoratedText_Control
- func (x *DecoratedText) GetEndIcon() *Icon
- func (x *DecoratedText) GetIcon() *Icondeprecated
- func (x *DecoratedText) GetOnClick() *OnClick
- func (x *DecoratedText) GetStartIcon() *Icon
- func (x *DecoratedText) GetSwitchControl() *DecoratedText_SwitchControl
- func (x *DecoratedText) GetText() string
- func (x *DecoratedText) GetTopLabel() string
- func (x *DecoratedText) GetWrapText() bool
- func (*DecoratedText) ProtoMessage()
- func (x *DecoratedText) ProtoReflect() protoreflect.Message
- func (x *DecoratedText) Reset()
- func (x *DecoratedText) String() string
- type DecoratedText_Button
- type DecoratedText_EndIcon
- type DecoratedText_SwitchControl
- func (*DecoratedText_SwitchControl) Descriptor() ([]byte, []int)deprecated
- func (x *DecoratedText_SwitchControl) GetControlType() DecoratedText_SwitchControl_ControlType
- func (x *DecoratedText_SwitchControl) GetName() string
- func (x *DecoratedText_SwitchControl) GetOnChangeAction() *Action
- func (x *DecoratedText_SwitchControl) GetSelected() bool
- func (x *DecoratedText_SwitchControl) GetValue() string
- func (*DecoratedText_SwitchControl) ProtoMessage()
- func (x *DecoratedText_SwitchControl) ProtoReflect() protoreflect.Message
- func (x *DecoratedText_SwitchControl) Reset()
- func (x *DecoratedText_SwitchControl) String() string
- type DecoratedText_SwitchControl_
- type DecoratedText_SwitchControl_ControlType
- func (DecoratedText_SwitchControl_ControlType) Descriptor() protoreflect.EnumDescriptor
- func (x DecoratedText_SwitchControl_ControlType) Enum() *DecoratedText_SwitchControl_ControlType
- func (DecoratedText_SwitchControl_ControlType) EnumDescriptor() ([]byte, []int)deprecated
- func (x DecoratedText_SwitchControl_ControlType) Number() protoreflect.EnumNumber
- func (x DecoratedText_SwitchControl_ControlType) String() string
- func (DecoratedText_SwitchControl_ControlType) Type() protoreflect.EnumType
- type Divider
- type Grid
- func (*Grid) Descriptor() ([]byte, []int)deprecated
- func (x *Grid) GetBorderStyle() *BorderStyle
- func (x *Grid) GetColumnCount() int32
- func (x *Grid) GetItems() []*Grid_GridItem
- func (x *Grid) GetOnClick() *OnClick
- func (x *Grid) GetTitle() string
- func (*Grid) ProtoMessage()
- func (x *Grid) ProtoReflect() protoreflect.Message
- func (x *Grid) Reset()
- func (x *Grid) String() string
- type Grid_GridItem
- func (*Grid_GridItem) Descriptor() ([]byte, []int)deprecated
- func (x *Grid_GridItem) GetId() string
- func (x *Grid_GridItem) GetImage() *ImageComponent
- func (x *Grid_GridItem) GetLayout() Grid_GridItem_GridItemLayout
- func (x *Grid_GridItem) GetSubtitle() string
- func (x *Grid_GridItem) GetTitle() string
- func (*Grid_GridItem) ProtoMessage()
- func (x *Grid_GridItem) ProtoReflect() protoreflect.Message
- func (x *Grid_GridItem) Reset()
- func (x *Grid_GridItem) String() string
- type Grid_GridItem_GridItemLayout
- func (Grid_GridItem_GridItemLayout) Descriptor() protoreflect.EnumDescriptor
- func (x Grid_GridItem_GridItemLayout) Enum() *Grid_GridItem_GridItemLayout
- func (Grid_GridItem_GridItemLayout) EnumDescriptor() ([]byte, []int)deprecated
- func (x Grid_GridItem_GridItemLayout) Number() protoreflect.EnumNumber
- func (x Grid_GridItem_GridItemLayout) String() string
- func (Grid_GridItem_GridItemLayout) Type() protoreflect.EnumType
- type Icon
- func (*Icon) Descriptor() ([]byte, []int)deprecated
- func (x *Icon) GetAltText() string
- func (x *Icon) GetIconUrl() string
- func (m *Icon) GetIcons() isIcon_Icons
- func (x *Icon) GetImageType() Widget_ImageType
- func (x *Icon) GetKnownIcon() string
- func (x *Icon) GetMaterialIcon() *MaterialIcon
- func (*Icon) ProtoMessage()
- func (x *Icon) ProtoReflect() protoreflect.Message
- func (x *Icon) Reset()
- func (x *Icon) String() string
- type Icon_IconUrl
- type Icon_KnownIcon
- type Icon_MaterialIcon
- type Image
- func (*Image) Descriptor() ([]byte, []int)deprecated
- func (x *Image) GetAltText() string
- func (x *Image) GetImageUrl() string
- func (x *Image) GetOnClick() *OnClick
- func (*Image) ProtoMessage()
- func (x *Image) ProtoReflect() protoreflect.Message
- func (x *Image) Reset()
- func (x *Image) String() string
- type ImageComponent
- func (*ImageComponent) Descriptor() ([]byte, []int)deprecated
- func (x *ImageComponent) GetAltText() string
- func (x *ImageComponent) GetBorderStyle() *BorderStyle
- func (x *ImageComponent) GetCropStyle() *ImageCropStyle
- func (x *ImageComponent) GetImageUri() string
- func (*ImageComponent) ProtoMessage()
- func (x *ImageComponent) ProtoReflect() protoreflect.Message
- func (x *ImageComponent) Reset()
- func (x *ImageComponent) String() string
- type ImageCropStyle
- func (*ImageCropStyle) Descriptor() ([]byte, []int)deprecated
- func (x *ImageCropStyle) GetAspectRatio() float64
- func (x *ImageCropStyle) GetType() ImageCropStyle_ImageCropType
- func (*ImageCropStyle) ProtoMessage()
- func (x *ImageCropStyle) ProtoReflect() protoreflect.Message
- func (x *ImageCropStyle) Reset()
- func (x *ImageCropStyle) String() string
- type ImageCropStyle_ImageCropType
- func (ImageCropStyle_ImageCropType) Descriptor() protoreflect.EnumDescriptor
- func (x ImageCropStyle_ImageCropType) Enum() *ImageCropStyle_ImageCropType
- func (ImageCropStyle_ImageCropType) EnumDescriptor() ([]byte, []int)deprecated
- func (x ImageCropStyle_ImageCropType) Number() protoreflect.EnumNumber
- func (x ImageCropStyle_ImageCropType) String() string
- func (ImageCropStyle_ImageCropType) Type() protoreflect.EnumType
- type MaterialIcon
- func (*MaterialIcon) Descriptor() ([]byte, []int)deprecated
- func (x *MaterialIcon) GetFill() bool
- func (x *MaterialIcon) GetGrade() int32
- func (x *MaterialIcon) GetName() string
- func (x *MaterialIcon) GetWeight() int32
- func (*MaterialIcon) ProtoMessage()
- func (x *MaterialIcon) ProtoReflect() protoreflect.Message
- func (x *MaterialIcon) Reset()
- func (x *MaterialIcon) String() string
- type OnClick
- func (*OnClick) Descriptor() ([]byte, []int)deprecated
- func (x *OnClick) GetAction() *Action
- func (x *OnClick) GetCard() *Card
- func (m *OnClick) GetData() isOnClick_Data
- func (x *OnClick) GetOpenDynamicLinkAction() *Action
- func (x *OnClick) GetOpenLink() *OpenLink
- func (*OnClick) ProtoMessage()
- func (x *OnClick) ProtoReflect() protoreflect.Message
- func (x *OnClick) Reset()
- func (x *OnClick) String() string
- type OnClick_Action
- type OnClick_Card
- type OnClick_OpenDynamicLinkAction
- type OnClick_OpenLink
- type OpenLink
- func (*OpenLink) Descriptor() ([]byte, []int)deprecated
- func (x *OpenLink) GetOnClose() OpenLink_OnClose
- func (x *OpenLink) GetOpenAs() OpenLink_OpenAs
- func (x *OpenLink) GetUrl() string
- func (*OpenLink) ProtoMessage()
- func (x *OpenLink) ProtoReflect() protoreflect.Message
- func (x *OpenLink) Reset()
- func (x *OpenLink) String() string
- type OpenLink_OnClose
- func (OpenLink_OnClose) Descriptor() protoreflect.EnumDescriptor
- func (x OpenLink_OnClose) Enum() *OpenLink_OnClose
- func (OpenLink_OnClose) EnumDescriptor() ([]byte, []int)deprecated
- func (x OpenLink_OnClose) Number() protoreflect.EnumNumber
- func (x OpenLink_OnClose) String() string
- func (OpenLink_OnClose) Type() protoreflect.EnumType
- type OpenLink_OpenAs
- func (OpenLink_OpenAs) Descriptor() protoreflect.EnumDescriptor
- func (x OpenLink_OpenAs) Enum() *OpenLink_OpenAs
- func (OpenLink_OpenAs) EnumDescriptor() ([]byte, []int)deprecated
- func (x OpenLink_OpenAs) Number() protoreflect.EnumNumber
- func (x OpenLink_OpenAs) String() string
- func (OpenLink_OpenAs) Type() protoreflect.EnumType
- type SelectionInput
- func (*SelectionInput) Descriptor() ([]byte, []int)deprecated
- func (x *SelectionInput) GetExternalDataSource() *Action
- func (x *SelectionInput) GetItems() []*SelectionInput_SelectionItem
- func (x *SelectionInput) GetLabel() string
- func (m *SelectionInput) GetMultiSelectDataSource() isSelectionInput_MultiSelectDataSource
- func (x *SelectionInput) GetMultiSelectMaxSelectedItems() int32
- func (x *SelectionInput) GetMultiSelectMinQueryLength() int32
- func (x *SelectionInput) GetName() string
- func (x *SelectionInput) GetOnChangeAction() *Action
- func (x *SelectionInput) GetPlatformDataSource() *SelectionInput_PlatformDataSource
- func (x *SelectionInput) GetType() SelectionInput_SelectionType
- func (*SelectionInput) ProtoMessage()
- func (x *SelectionInput) ProtoReflect() protoreflect.Message
- func (x *SelectionInput) Reset()
- func (x *SelectionInput) String() string
- type SelectionInput_ExternalDataSource
- type SelectionInput_PlatformDataSource
- func (*SelectionInput_PlatformDataSource) Descriptor() ([]byte, []int)deprecated
- func (x *SelectionInput_PlatformDataSource) GetCommonDataSource() SelectionInput_PlatformDataSource_CommonDataSource
- func (m *SelectionInput_PlatformDataSource) GetDataSource() isSelectionInput_PlatformDataSource_DataSource
- func (*SelectionInput_PlatformDataSource) ProtoMessage()
- func (x *SelectionInput_PlatformDataSource) ProtoReflect() protoreflect.Message
- func (x *SelectionInput_PlatformDataSource) Reset()
- func (x *SelectionInput_PlatformDataSource) String() string
- type SelectionInput_PlatformDataSource_
- type SelectionInput_PlatformDataSource_CommonDataSource
- func (SelectionInput_PlatformDataSource_CommonDataSource) Descriptor() protoreflect.EnumDescriptor
- func (x SelectionInput_PlatformDataSource_CommonDataSource) Enum() *SelectionInput_PlatformDataSource_CommonDataSource
- func (SelectionInput_PlatformDataSource_CommonDataSource) EnumDescriptor() ([]byte, []int)deprecated
- func (x SelectionInput_PlatformDataSource_CommonDataSource) Number() protoreflect.EnumNumber
- func (x SelectionInput_PlatformDataSource_CommonDataSource) String() string
- func (SelectionInput_PlatformDataSource_CommonDataSource) Type() protoreflect.EnumType
- type SelectionInput_PlatformDataSource_CommonDataSource_
- type SelectionInput_SelectionItem
- func (*SelectionInput_SelectionItem) Descriptor() ([]byte, []int)deprecated
- func (x *SelectionInput_SelectionItem) GetBottomText() string
- func (x *SelectionInput_SelectionItem) GetSelected() bool
- func (x *SelectionInput_SelectionItem) GetStartIconUri() string
- func (x *SelectionInput_SelectionItem) GetText() string
- func (x *SelectionInput_SelectionItem) GetValue() string
- func (*SelectionInput_SelectionItem) ProtoMessage()
- func (x *SelectionInput_SelectionItem) ProtoReflect() protoreflect.Message
- func (x *SelectionInput_SelectionItem) Reset()
- func (x *SelectionInput_SelectionItem) String() string
- type SelectionInput_SelectionType
- func (SelectionInput_SelectionType) Descriptor() protoreflect.EnumDescriptor
- func (x SelectionInput_SelectionType) Enum() *SelectionInput_SelectionType
- func (SelectionInput_SelectionType) EnumDescriptor() ([]byte, []int)deprecated
- func (x SelectionInput_SelectionType) Number() protoreflect.EnumNumber
- func (x SelectionInput_SelectionType) String() string
- func (SelectionInput_SelectionType) Type() protoreflect.EnumType
- type Suggestions
- type Suggestions_SuggestionItem
- func (*Suggestions_SuggestionItem) Descriptor() ([]byte, []int)deprecated
- func (m *Suggestions_SuggestionItem) GetContent() isSuggestions_SuggestionItem_Content
- func (x *Suggestions_SuggestionItem) GetText() string
- func (*Suggestions_SuggestionItem) ProtoMessage()
- func (x *Suggestions_SuggestionItem) ProtoReflect() protoreflect.Message
- func (x *Suggestions_SuggestionItem) Reset()
- func (x *Suggestions_SuggestionItem) String() string
- type Suggestions_SuggestionItem_Text
- type TextInput
- func (*TextInput) Descriptor() ([]byte, []int)deprecated
- func (x *TextInput) GetAutoCompleteAction() *Action
- func (x *TextInput) GetHintText() string
- func (x *TextInput) GetInitialSuggestions() *Suggestions
- func (x *TextInput) GetLabel() string
- func (x *TextInput) GetName() string
- func (x *TextInput) GetOnChangeAction() *Action
- func (x *TextInput) GetPlaceholderText() string
- func (x *TextInput) GetType() TextInput_Type
- func (x *TextInput) GetValue() string
- func (*TextInput) ProtoMessage()
- func (x *TextInput) ProtoReflect() protoreflect.Message
- func (x *TextInput) Reset()
- func (x *TextInput) String() string
- type TextInput_Type
- func (TextInput_Type) Descriptor() protoreflect.EnumDescriptor
- func (x TextInput_Type) Enum() *TextInput_Type
- func (TextInput_Type) EnumDescriptor() ([]byte, []int)deprecated
- func (x TextInput_Type) Number() protoreflect.EnumNumber
- func (x TextInput_Type) String() string
- func (TextInput_Type) Type() protoreflect.EnumType
- type TextParagraph
- type Widget
- func (*Widget) Descriptor() ([]byte, []int)deprecated
- func (x *Widget) GetButtonList() *ButtonList
- func (x *Widget) GetColumns() *Columns
- func (m *Widget) GetData() isWidget_Data
- func (x *Widget) GetDateTimePicker() *DateTimePicker
- func (x *Widget) GetDecoratedText() *DecoratedText
- func (x *Widget) GetDivider() *Divider
- func (x *Widget) GetGrid() *Grid
- func (x *Widget) GetHorizontalAlignment() Widget_HorizontalAlignment
- func (x *Widget) GetImage() *Image
- func (x *Widget) GetSelectionInput() *SelectionInput
- func (x *Widget) GetTextInput() *TextInput
- func (x *Widget) GetTextParagraph() *TextParagraph
- func (*Widget) ProtoMessage()
- func (x *Widget) ProtoReflect() protoreflect.Message
- func (x *Widget) Reset()
- func (x *Widget) String() string
- type Widget_ButtonList
- type Widget_Columns
- type Widget_DateTimePicker
- type Widget_DecoratedText
- type Widget_Divider
- type Widget_Grid
- type Widget_HorizontalAlignment
- func (Widget_HorizontalAlignment) Descriptor() protoreflect.EnumDescriptor
- func (x Widget_HorizontalAlignment) Enum() *Widget_HorizontalAlignment
- func (Widget_HorizontalAlignment) EnumDescriptor() ([]byte, []int)deprecated
- func (x Widget_HorizontalAlignment) Number() protoreflect.EnumNumber
- func (x Widget_HorizontalAlignment) String() string
- func (Widget_HorizontalAlignment) Type() protoreflect.EnumType
- type Widget_Image
- type Widget_ImageType
- func (Widget_ImageType) Descriptor() protoreflect.EnumDescriptor
- func (x Widget_ImageType) Enum() *Widget_ImageType
- func (Widget_ImageType) EnumDescriptor() ([]byte, []int)deprecated
- func (x Widget_ImageType) Number() protoreflect.EnumNumber
- func (x Widget_ImageType) String() string
- func (Widget_ImageType) Type() protoreflect.EnumType
- type Widget_SelectionInput
- type Widget_TextInput
- type Widget_TextParagraph
Constants ¶
This section is empty.
Variables ¶
var ( Card_DividerStyle_name = map[int32]string{ 0: "DIVIDER_STYLE_UNSPECIFIED", 1: "SOLID_DIVIDER", 2: "NO_DIVIDER", } Card_DividerStyle_value = map[string]int32{ "DIVIDER_STYLE_UNSPECIFIED": 0, "SOLID_DIVIDER": 1, "NO_DIVIDER": 2, } )
Enum value maps for Card_DividerStyle.
var ( Card_DisplayStyle_name = map[int32]string{ 0: "DISPLAY_STYLE_UNSPECIFIED", 1: "PEEK", 2: "REPLACE", } Card_DisplayStyle_value = map[string]int32{ "DISPLAY_STYLE_UNSPECIFIED": 0, "PEEK": 1, "REPLACE": 2, } )
Enum value maps for Card_DisplayStyle.
var ( Widget_ImageType_name = map[int32]string{ 0: "SQUARE", 1: "CIRCLE", } Widget_ImageType_value = map[string]int32{ "SQUARE": 0, "CIRCLE": 1, } )
Enum value maps for Widget_ImageType.
var ( Widget_HorizontalAlignment_name = map[int32]string{ 0: "HORIZONTAL_ALIGNMENT_UNSPECIFIED", 1: "START", 2: "CENTER", 3: "END", } Widget_HorizontalAlignment_value = map[string]int32{ "HORIZONTAL_ALIGNMENT_UNSPECIFIED": 0, "START": 1, "CENTER": 2, "END": 3, } )
Enum value maps for Widget_HorizontalAlignment.
var ( DecoratedText_SwitchControl_ControlType_name = map[int32]string{ 0: "SWITCH", 1: "CHECKBOX", 2: "CHECK_BOX", } DecoratedText_SwitchControl_ControlType_value = map[string]int32{ "SWITCH": 0, "CHECKBOX": 1, "CHECK_BOX": 2, } )
Enum value maps for DecoratedText_SwitchControl_ControlType.
var ( TextInput_Type_name = map[int32]string{ 0: "SINGLE_LINE", 1: "MULTIPLE_LINE", } TextInput_Type_value = map[string]int32{ "SINGLE_LINE": 0, "MULTIPLE_LINE": 1, } )
Enum value maps for TextInput_Type.
var ( SelectionInput_SelectionType_name = map[int32]string{ 0: "CHECK_BOX", 1: "RADIO_BUTTON", 2: "SWITCH", 3: "DROPDOWN", 4: "MULTI_SELECT", } SelectionInput_SelectionType_value = map[string]int32{ "CHECK_BOX": 0, "RADIO_BUTTON": 1, "SWITCH": 2, "DROPDOWN": 3, "MULTI_SELECT": 4, } )
Enum value maps for SelectionInput_SelectionType.
var ( SelectionInput_PlatformDataSource_CommonDataSource_name = map[int32]string{ 0: "UNKNOWN", 1: "USER", } SelectionInput_PlatformDataSource_CommonDataSource_value = map[string]int32{ "UNKNOWN": 0, "USER": 1, } )
Enum value maps for SelectionInput_PlatformDataSource_CommonDataSource.
var ( DateTimePicker_DateTimePickerType_name = map[int32]string{ 0: "DATE_AND_TIME", 1: "DATE_ONLY", 2: "TIME_ONLY", } DateTimePicker_DateTimePickerType_value = map[string]int32{ "DATE_AND_TIME": 0, "DATE_ONLY": 1, "TIME_ONLY": 2, } )
Enum value maps for DateTimePicker_DateTimePickerType.
var ( ImageCropStyle_ImageCropType_name = map[int32]string{ 0: "IMAGE_CROP_TYPE_UNSPECIFIED", 1: "SQUARE", 2: "CIRCLE", 3: "RECTANGLE_CUSTOM", 4: "RECTANGLE_4_3", } ImageCropStyle_ImageCropType_value = map[string]int32{ "IMAGE_CROP_TYPE_UNSPECIFIED": 0, "SQUARE": 1, "CIRCLE": 2, "RECTANGLE_CUSTOM": 3, "RECTANGLE_4_3": 4, } )
Enum value maps for ImageCropStyle_ImageCropType.
var ( BorderStyle_BorderType_name = map[int32]string{ 0: "BORDER_TYPE_UNSPECIFIED", 1: "NO_BORDER", 2: "STROKE", } BorderStyle_BorderType_value = map[string]int32{ "BORDER_TYPE_UNSPECIFIED": 0, "NO_BORDER": 1, "STROKE": 2, } )
Enum value maps for BorderStyle_BorderType.
var ( Grid_GridItem_GridItemLayout_name = map[int32]string{ 0: "GRID_ITEM_LAYOUT_UNSPECIFIED", 1: "TEXT_BELOW", 2: "TEXT_ABOVE", } Grid_GridItem_GridItemLayout_value = map[string]int32{ "GRID_ITEM_LAYOUT_UNSPECIFIED": 0, "TEXT_BELOW": 1, "TEXT_ABOVE": 2, } )
Enum value maps for Grid_GridItem_GridItemLayout.
var ( Columns_Column_HorizontalSizeStyle_name = map[int32]string{ 0: "HORIZONTAL_SIZE_STYLE_UNSPECIFIED", 1: "FILL_AVAILABLE_SPACE", 2: "FILL_MINIMUM_SPACE", } Columns_Column_HorizontalSizeStyle_value = map[string]int32{ "HORIZONTAL_SIZE_STYLE_UNSPECIFIED": 0, "FILL_AVAILABLE_SPACE": 1, "FILL_MINIMUM_SPACE": 2, } )
Enum value maps for Columns_Column_HorizontalSizeStyle.
var ( Columns_Column_VerticalAlignment_name = map[int32]string{ 0: "VERTICAL_ALIGNMENT_UNSPECIFIED", 1: "CENTER", 2: "TOP", 3: "BOTTOM", } Columns_Column_VerticalAlignment_value = map[string]int32{ "VERTICAL_ALIGNMENT_UNSPECIFIED": 0, "CENTER": 1, "TOP": 2, "BOTTOM": 3, } )
Enum value maps for Columns_Column_VerticalAlignment.
var ( OpenLink_OpenAs_name = map[int32]string{ 0: "FULL_SIZE", 1: "OVERLAY", } OpenLink_OpenAs_value = map[string]int32{ "FULL_SIZE": 0, "OVERLAY": 1, } )
Enum value maps for OpenLink_OpenAs.
var ( OpenLink_OnClose_name = map[int32]string{ 0: "NOTHING", 1: "RELOAD", } OpenLink_OnClose_value = map[string]int32{ "NOTHING": 0, "RELOAD": 1, } )
Enum value maps for OpenLink_OnClose.
var ( Action_LoadIndicator_name = map[int32]string{ 0: "SPINNER", 1: "NONE", } Action_LoadIndicator_value = map[string]int32{ "SPINNER": 0, "NONE": 1, } )
Enum value maps for Action_LoadIndicator.
var ( Action_Interaction_name = map[int32]string{ 0: "INTERACTION_UNSPECIFIED", 1: "OPEN_DIALOG", } Action_Interaction_value = map[string]int32{ "INTERACTION_UNSPECIFIED": 0, "OPEN_DIALOG": 1, } )
Enum value maps for Action_Interaction.
var File_google_apps_card_v1_card_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Action ¶
type Action struct { // A custom function to invoke when the containing element is // clicked or othrwise activated. // // For example usage, see [Read form // data](https://developers.google.com/workspace/chat/read-form-data). Function string `protobuf:"bytes,1,opt,name=function,proto3" json:"function,omitempty"` // List of action parameters. Parameters []*Action_ActionParameter `protobuf:"bytes,2,rep,name=parameters,proto3" json:"parameters,omitempty"` // Specifies the loading indicator that the action displays while // making the call to the action. LoadIndicator Action_LoadIndicator `` /* 147-byte string literal not displayed */ // Indicates whether form values persist after the action. The default value // is `false`. // // If `true`, form values remain after the action is triggered. To let the // user make changes while the action is being processed, set // [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) // to `NONE`. For [card // messages](https://developers.google.com/workspace/chat/api/guides/v1/messages/create#create) // in Chat apps, you must also set the action's // [`ResponseType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#responsetype) // to `UPDATE_MESSAGE` and use the same // [`card_id`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#CardWithId) // from the card that contained the action. // // If `false`, the form values are cleared when the action is triggered. // To prevent the user from making changes while the action is being // processed, set // [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) // to `SPINNER`. PersistValues bool `protobuf:"varint,4,opt,name=persist_values,json=persistValues,proto3" json:"persist_values,omitempty"` // Optional. Required when opening a // [dialog](https://developers.google.com/workspace/chat/dialogs). // // What to do in response to an interaction with a user, such as a user // clicking a button in a card message. // // If unspecified, the app responds by executing an `action`—like opening a // link or running a function—as normal. // // By specifying an `interaction`, the app can respond in special interactive // ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can // open a [dialog](https://developers.google.com/workspace/chat/dialogs). When // specified, a loading indicator isn't shown. If specified for // an add-on, the entire card is stripped and nothing is shown in the client. // // [Google Chat apps](https://developers.google.com/workspace/chat): Interaction Action_Interaction `protobuf:"varint,5,opt,name=interaction,proto3,enum=google.apps.card.v1.Action_Interaction" json:"interaction,omitempty"` // contains filtered or unexported fields }
An action that describes the behavior when the form is submitted. For example, you can invoke an Apps Script script to handle the form. If the action is triggered, the form values are sent to the server.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
func (*Action) Descriptor
deprecated
func (*Action) GetFunction ¶
func (*Action) GetInteraction ¶
func (x *Action) GetInteraction() Action_Interaction
func (*Action) GetLoadIndicator ¶
func (x *Action) GetLoadIndicator() Action_LoadIndicator
func (*Action) GetParameters ¶
func (x *Action) GetParameters() []*Action_ActionParameter
func (*Action) GetPersistValues ¶
func (*Action) ProtoMessage ¶
func (*Action) ProtoMessage()
func (*Action) ProtoReflect ¶
func (x *Action) ProtoReflect() protoreflect.Message
type Action_ActionParameter ¶
type Action_ActionParameter struct { // The name of the parameter for the action script. Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` // The value of the parameter. Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, or snooze next week. You might use `action method = snooze()`, passing the snooze type and snooze time in the list of string parameters.
To learn more, see [`CommonEventObject`](https://developers.google.com/workspace/chat/api/reference/rest/v1/Event#commoneventobject).
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
func (*Action_ActionParameter) Descriptor
deprecated
func (*Action_ActionParameter) Descriptor() ([]byte, []int)
Deprecated: Use Action_ActionParameter.ProtoReflect.Descriptor instead.
func (*Action_ActionParameter) GetKey ¶
func (x *Action_ActionParameter) GetKey() string
func (*Action_ActionParameter) GetValue ¶
func (x *Action_ActionParameter) GetValue() string
func (*Action_ActionParameter) ProtoMessage ¶
func (*Action_ActionParameter) ProtoMessage()
func (*Action_ActionParameter) ProtoReflect ¶
func (x *Action_ActionParameter) ProtoReflect() protoreflect.Message
func (*Action_ActionParameter) Reset ¶
func (x *Action_ActionParameter) Reset()
func (*Action_ActionParameter) String ¶
func (x *Action_ActionParameter) String() string
type Action_Interaction ¶
type Action_Interaction int32
Optional. Required when opening a [dialog](https://developers.google.com/workspace/chat/dialogs).
What to do in response to an interaction with a user, such as a user clicking a button in a card message.
If unspecified, the app responds by executing an `action`—like opening a link or running a function—as normal.
By specifying an `interaction`, the app can respond in special interactive ways. For example, by setting `interaction` to `OPEN_DIALOG`, the app can open a [dialog](https://developers.google.com/workspace/chat/dialogs).
When specified, a loading indicator isn't shown. If specified for an add-on, the entire card is stripped and nothing is shown in the client.
[Google Chat apps](https://developers.google.com/workspace/chat):
const ( // Default value. The `action` executes as normal. Action_INTERACTION_UNSPECIFIED Action_Interaction = 0 // Opens a [dialog](https://developers.google.com/workspace/chat/dialogs), a // windowed, card-based interface that Chat apps use to interact with users. // // Only supported by Chat apps in response to button-clicks on card // messages. If specified for // an add-on, the entire card is stripped and nothing is shown in the // client. // // [Google Chat apps](https://developers.google.com/workspace/chat): Action_OPEN_DIALOG Action_Interaction = 1 )
func (Action_Interaction) Descriptor ¶
func (Action_Interaction) Descriptor() protoreflect.EnumDescriptor
func (Action_Interaction) Enum ¶
func (x Action_Interaction) Enum() *Action_Interaction
func (Action_Interaction) EnumDescriptor
deprecated
func (Action_Interaction) EnumDescriptor() ([]byte, []int)
Deprecated: Use Action_Interaction.Descriptor instead.
func (Action_Interaction) Number ¶
func (x Action_Interaction) Number() protoreflect.EnumNumber
func (Action_Interaction) String ¶
func (x Action_Interaction) String() string
func (Action_Interaction) Type ¶
func (Action_Interaction) Type() protoreflect.EnumType
type Action_LoadIndicator ¶
type Action_LoadIndicator int32
Specifies the loading indicator that the action displays while making the call to the action.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
const ( // Displays a spinner to indicate that content is loading. Action_SPINNER Action_LoadIndicator = 0 // Nothing is displayed. Action_NONE Action_LoadIndicator = 1 )
func (Action_LoadIndicator) Descriptor ¶
func (Action_LoadIndicator) Descriptor() protoreflect.EnumDescriptor
func (Action_LoadIndicator) Enum ¶
func (x Action_LoadIndicator) Enum() *Action_LoadIndicator
func (Action_LoadIndicator) EnumDescriptor
deprecated
func (Action_LoadIndicator) EnumDescriptor() ([]byte, []int)
Deprecated: Use Action_LoadIndicator.Descriptor instead.
func (Action_LoadIndicator) Number ¶
func (x Action_LoadIndicator) Number() protoreflect.EnumNumber
func (Action_LoadIndicator) String ¶
func (x Action_LoadIndicator) String() string
func (Action_LoadIndicator) Type ¶
func (Action_LoadIndicator) Type() protoreflect.EnumType
type BorderStyle ¶
type BorderStyle struct { // The border type. Type BorderStyle_BorderType `protobuf:"varint,1,opt,name=type,proto3,enum=google.apps.card.v1.BorderStyle_BorderType" json:"type,omitempty"` // The colors to use when the type is `BORDER_TYPE_STROKE`. StrokeColor *color.Color `protobuf:"bytes,2,opt,name=stroke_color,json=strokeColor,proto3" json:"stroke_color,omitempty"` // The corner radius for the border. CornerRadius int32 `protobuf:"varint,3,opt,name=corner_radius,json=cornerRadius,proto3" json:"corner_radius,omitempty"` // contains filtered or unexported fields }
The style options for the border of a card or widget, including the border type and color.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
func (*BorderStyle) Descriptor
deprecated
func (*BorderStyle) Descriptor() ([]byte, []int)
Deprecated: Use BorderStyle.ProtoReflect.Descriptor instead.
func (*BorderStyle) GetCornerRadius ¶
func (x *BorderStyle) GetCornerRadius() int32
func (*BorderStyle) GetStrokeColor ¶
func (x *BorderStyle) GetStrokeColor() *color.Color
func (*BorderStyle) GetType ¶
func (x *BorderStyle) GetType() BorderStyle_BorderType
func (*BorderStyle) ProtoMessage ¶
func (*BorderStyle) ProtoMessage()
func (*BorderStyle) ProtoReflect ¶
func (x *BorderStyle) ProtoReflect() protoreflect.Message
func (*BorderStyle) Reset ¶
func (x *BorderStyle) Reset()
func (*BorderStyle) String ¶
func (x *BorderStyle) String() string
type BorderStyle_BorderType ¶
type BorderStyle_BorderType int32
Represents the border types applied to widgets.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
const ( // Don't use. Unspecified. BorderStyle_BORDER_TYPE_UNSPECIFIED BorderStyle_BorderType = 0 // Default value. No border. BorderStyle_NO_BORDER BorderStyle_BorderType = 1 // Outline. BorderStyle_STROKE BorderStyle_BorderType = 2 )
func (BorderStyle_BorderType) Descriptor ¶
func (BorderStyle_BorderType) Descriptor() protoreflect.EnumDescriptor
func (BorderStyle_BorderType) Enum ¶
func (x BorderStyle_BorderType) Enum() *BorderStyle_BorderType
func (BorderStyle_BorderType) EnumDescriptor
deprecated
func (BorderStyle_BorderType) EnumDescriptor() ([]byte, []int)
Deprecated: Use BorderStyle_BorderType.Descriptor instead.
func (BorderStyle_BorderType) Number ¶
func (x BorderStyle_BorderType) Number() protoreflect.EnumNumber
func (BorderStyle_BorderType) String ¶
func (x BorderStyle_BorderType) String() string
func (BorderStyle_BorderType) Type ¶
func (BorderStyle_BorderType) Type() protoreflect.EnumType
type Button ¶
type Button struct { // The text displayed inside the button. Text string `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"` // The icon image. If both `icon` and `text` are set, then the icon appears // before the text. Icon *Icon `protobuf:"bytes,2,opt,name=icon,proto3" json:"icon,omitempty"` // 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 *color.Color `protobuf:"bytes,3,opt,name=color,proto3" json:"color,omitempty"` // Required. The action to perform when a user clicks the button, such as // opening a hyperlink or running a custom function. OnClick *OnClick `protobuf:"bytes,4,opt,name=on_click,json=onClick,proto3" json:"on_click,omitempty"` // If `true`, the button is displayed in an inactive state and doesn't respond // to user actions. Disabled bool `protobuf:"varint,5,opt,name=disabled,proto3" json:"disabled,omitempty"` // 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". AltText string `protobuf:"bytes,6,opt,name=alt_text,json=altText,proto3" json:"alt_text,omitempty"` // contains filtered or unexported fields }
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):
func (*Button) Descriptor
deprecated
func (*Button) GetAltText ¶
func (*Button) GetDisabled ¶
func (*Button) GetOnClick ¶
func (*Button) ProtoMessage ¶
func (*Button) ProtoMessage()
func (*Button) ProtoReflect ¶
func (x *Button) ProtoReflect() protoreflect.Message
type ButtonList ¶
type ButtonList struct { // An array of buttons. Buttons []*Button `protobuf:"bytes,1,rep,name=buttons,proto3" json:"buttons,omitempty"` // contains filtered or unexported fields }
A list of buttons layed out horizontally. For an example in Google Chat apps, see [Add a button](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_button).
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
func (*ButtonList) Descriptor
deprecated
func (*ButtonList) Descriptor() ([]byte, []int)
Deprecated: Use ButtonList.ProtoReflect.Descriptor instead.
func (*ButtonList) GetButtons ¶
func (x *ButtonList) GetButtons() []*Button
func (*ButtonList) ProtoMessage ¶
func (*ButtonList) ProtoMessage()
func (*ButtonList) ProtoReflect ¶
func (x *ButtonList) ProtoReflect() protoreflect.Message
func (*ButtonList) Reset ¶
func (x *ButtonList) Reset()
func (*ButtonList) String ¶
func (x *ButtonList) String() string
type Card ¶
type Card struct { // The header of the card. A header usually contains a leading image and a // title. Headers always appear at the top of a card. Header *Card_CardHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"` // Contains a collection of widgets. Each section has its own, optional // header. Sections are visually separated by a line divider. For an example // in Google Chat apps, see [Define a section of a // card](https://developers.google.com/workspace/chat/design-components-card-dialog#define_a_section_of_a_card). Sections []*Card_Section `protobuf:"bytes,2,rep,name=sections,proto3" json:"sections,omitempty"` // The divider style between sections. SectionDividerStyle Card_DividerStyle `` /* 164-byte string literal not displayed */ // The card's actions. Actions are added to the card's toolbar menu. // // [Google Workspace // Add-ons](https://developers.google.com/workspace/add-ons): // // For example, the following JSON constructs a card action menu with // `Settings` and `Send Feedback` options: // // “` // "card_actions": [ // // { // "actionLabel": "Settings", // "onClick": { // "action": { // "functionName": "goToView", // "parameters": [ // { // "key": "viewType", // "value": "SETTING" // } // ], // "loadIndicator": "LoadIndicator.SPINNER" // } // } // }, // { // "actionLabel": "Send Feedback", // "onClick": { // "openLink": { // "url": "https://example.com/feedback" // } // } // } // // ] // “` CardActions []*Card_CardAction `protobuf:"bytes,3,rep,name=card_actions,json=cardActions,proto3" json:"card_actions,omitempty"` // Name of the card. Used as a card identifier in card navigation. // // [Google Workspace // Add-ons](https://developers.google.com/workspace/add-ons): Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"` // // Setting `fixedFooter` without specifying a `primaryButton` or a // `secondaryButton` causes an error. For Chat apps, you can use fixed footers // in // [dialogs](https://developers.google.com/workspace/chat/dialogs), but not // [card // messages](https://developers.google.com/workspace/chat/create-messages#create). // // [Google Workspace Add-ons and Chat // apps](https://developers.google.com/workspace/extend): FixedFooter *Card_CardFixedFooter `protobuf:"bytes,5,opt,name=fixed_footer,json=fixedFooter,proto3" json:"fixed_footer,omitempty"` // In Google Workspace Add-ons, sets the display properties of the // `peekCardHeader`. // // [Google Workspace // Add-ons](https://developers.google.com/workspace/add-ons): DisplayStyle Card_DisplayStyle `` /* 141-byte string literal not displayed */ // When displaying contextual content, the peek card header acts as a // placeholder so that the user can navigate forward between the homepage // cards and the contextual cards. // // [Google Workspace // Add-ons](https://developers.google.com/workspace/add-ons): PeekCardHeader *Card_CardHeader `protobuf:"bytes,7,opt,name=peek_card_header,json=peekCardHeader,proto3" json:"peek_card_header,omitempty"` // contains filtered or unexported fields }
A card interface displayed in a Google Chat message or Google Workspace Add-on.
Cards support a defined layout, interactive UI elements like buttons, and rich media like images. Use cards to present detailed information, gather information from users, and guide users to take a next step.
[Card builder](https://addons.gsuite.google.com/uikit/builder)
To learn how to build cards, see the following documentation:
- For Google Chat apps, see [Design the components of a card or dialog](https://developers.google.com/workspace/chat/design-components-card-dialog).
- For Google Workspace Add-ons, see [Card-based
interfaces](https://developers.google.com/apps-script/add-ons/concepts/cards).
**Example: Card message for a Google Chat app**
![Example contact card](https://developers.google.com/workspace/chat/images/card_api_reference.png)
To create the sample card message in Google Chat, use the following JSON:
```
{ "cardsV2": [ { "cardId": "unique-card-id", "card": { "header": { "title": "Sasha", "subtitle": "Software Engineer", "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "imageType": "CIRCLE", "imageAltText": "Avatar for Sasha" }, "sections": [ { "header": "Contact Info", "collapsible": true, "uncollapsibleWidgetsCount": 1, "widgets": [ { "decoratedText": { "startIcon": { "knownIcon": "EMAIL" }, "text": "sasha@example.com" } }, { "decoratedText": { "startIcon": { "knownIcon": "PERSON" }, "text": "<font color=\"#80e27e\">Online</font>" } }, { "decoratedText": { "startIcon": { "knownIcon": "PHONE" }, "text": "+1 (555) 555-1234" } }, { "buttonList": { "buttons": [ { "text": "Share", "onClick": { "openLink": { "url": "https://example.com/share" } } }, { "text": "Edit", "onClick": { "action": { "function": "goToView", "parameters": [ { "key": "viewType", "value": "EDIT" } ] } } } ] } } ] } ] } } ] }
```
func (*Card) Descriptor
deprecated
func (*Card) GetCardActions ¶
func (x *Card) GetCardActions() []*Card_CardAction
func (*Card) GetDisplayStyle ¶
func (x *Card) GetDisplayStyle() Card_DisplayStyle
func (*Card) GetFixedFooter ¶
func (x *Card) GetFixedFooter() *Card_CardFixedFooter
func (*Card) GetHeader ¶
func (x *Card) GetHeader() *Card_CardHeader
func (*Card) GetPeekCardHeader ¶
func (x *Card) GetPeekCardHeader() *Card_CardHeader
func (*Card) GetSectionDividerStyle ¶
func (x *Card) GetSectionDividerStyle() Card_DividerStyle
func (*Card) GetSections ¶
func (x *Card) GetSections() []*Card_Section
func (*Card) ProtoMessage ¶
func (*Card) ProtoMessage()
func (*Card) ProtoReflect ¶
func (x *Card) ProtoReflect() protoreflect.Message
type Card_CardAction ¶
type Card_CardAction struct { // The label that displays as the action menu item. ActionLabel string `protobuf:"bytes,1,opt,name=action_label,json=actionLabel,proto3" json:"action_label,omitempty"` // The `onClick` action for this action item. OnClick *OnClick `protobuf:"bytes,2,opt,name=on_click,json=onClick,proto3" json:"on_click,omitempty"` // contains filtered or unexported fields }
A card action is the action associated with the card. For example, an invoice card might include actions such as delete invoice, email invoice, or open the invoice in a browser.
[Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):
func (*Card_CardAction) Descriptor
deprecated
func (*Card_CardAction) Descriptor() ([]byte, []int)
Deprecated: Use Card_CardAction.ProtoReflect.Descriptor instead.
func (*Card_CardAction) GetActionLabel ¶
func (x *Card_CardAction) GetActionLabel() string
func (*Card_CardAction) GetOnClick ¶
func (x *Card_CardAction) GetOnClick() *OnClick
func (*Card_CardAction) ProtoMessage ¶
func (*Card_CardAction) ProtoMessage()
func (*Card_CardAction) ProtoReflect ¶
func (x *Card_CardAction) ProtoReflect() protoreflect.Message
func (*Card_CardAction) Reset ¶
func (x *Card_CardAction) Reset()
func (*Card_CardAction) String ¶
func (x *Card_CardAction) String() string
type Card_CardFixedFooter ¶
type Card_CardFixedFooter struct { // with text and color set. PrimaryButton *Button `protobuf:"bytes,1,opt,name=primary_button,json=primaryButton,proto3" json:"primary_button,omitempty"` // button with text and color set. // If `secondaryButton` is set, you must also set `primaryButton`. SecondaryButton *Button `protobuf:"bytes,2,opt,name=secondary_button,json=secondaryButton,proto3" json:"secondary_button,omitempty"` // contains filtered or unexported fields }
A persistent (sticky) footer that that appears at the bottom of the card.
Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error.
For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/workspace/chat/dialogs), but not [card messages](https://developers.google.com/workspace/chat/create-messages#create). For an example in Google Chat apps, see [Add a persistent footer](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_persistent_footer).
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
func (*Card_CardFixedFooter) Descriptor
deprecated
func (*Card_CardFixedFooter) Descriptor() ([]byte, []int)
Deprecated: Use Card_CardFixedFooter.ProtoReflect.Descriptor instead.
func (*Card_CardFixedFooter) GetPrimaryButton ¶
func (x *Card_CardFixedFooter) GetPrimaryButton() *Button
func (*Card_CardFixedFooter) GetSecondaryButton ¶
func (x *Card_CardFixedFooter) GetSecondaryButton() *Button
func (*Card_CardFixedFooter) ProtoMessage ¶
func (*Card_CardFixedFooter) ProtoMessage()
func (*Card_CardFixedFooter) ProtoReflect ¶
func (x *Card_CardFixedFooter) ProtoReflect() protoreflect.Message
func (*Card_CardFixedFooter) Reset ¶
func (x *Card_CardFixedFooter) Reset()
func (*Card_CardFixedFooter) String ¶
func (x *Card_CardFixedFooter) String() string
type Card_CardHeader ¶
type Card_CardHeader struct { // Required. The title of the card header. // The header has a fixed height: if both a // title and subtitle are specified, each takes up one line. If only the // title is specified, it takes up both lines. Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"` // The subtitle of the card header. If specified, appears on its own line // below the `title`. Subtitle string `protobuf:"bytes,2,opt,name=subtitle,proto3" json:"subtitle,omitempty"` // The shape used to crop the image. // // [Google Workspace Add-ons and Chat // apps](https://developers.google.com/workspace/extend): ImageType Widget_ImageType `` /* 131-byte string literal not displayed */ // The HTTPS URL of the image in the card header. ImageUrl string `protobuf:"bytes,4,opt,name=image_url,json=imageUrl,proto3" json:"image_url,omitempty"` // The alternative text of this image that's used for accessibility. ImageAltText string `protobuf:"bytes,5,opt,name=image_alt_text,json=imageAltText,proto3" json:"image_alt_text,omitempty"` // contains filtered or unexported fields }
Represents a card header. For an example in Google Chat apps, see [Add a header](https://developers.google.com/workspace/chat/design-components-card-dialog#add_a_header).
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
func (*Card_CardHeader) Descriptor
deprecated
func (*Card_CardHeader) Descriptor() ([]byte, []int)
Deprecated: Use Card_CardHeader.ProtoReflect.Descriptor instead.
func (*Card_CardHeader) GetImageAltText ¶
func (x *Card_CardHeader) GetImageAltText() string
func (*Card_CardHeader) GetImageType ¶
func (x *Card_CardHeader) GetImageType() Widget_ImageType
func (*Card_CardHeader) GetImageUrl ¶
func (x *Card_CardHeader) GetImageUrl() string
func (*Card_CardHeader) GetSubtitle ¶
func (x *Card_CardHeader) GetSubtitle() string
func (*Card_CardHeader) GetTitle ¶
func (x *Card_CardHeader) GetTitle() string
func (*Card_CardHeader) ProtoMessage ¶
func (*Card_CardHeader) ProtoMessage()
func (*Card_CardHeader) ProtoReflect ¶
func (x *Card_CardHeader) ProtoReflect() protoreflect.Message
func (*Card_CardHeader) Reset ¶
func (x *Card_CardHeader) Reset()
func (*Card_CardHeader) String ¶
func (x *Card_CardHeader) String() string
type Card_DisplayStyle ¶
type Card_DisplayStyle int32
In Google Workspace Add-ons, determines how a card is displayed.
[Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):
const ( // Don't use. Unspecified. Card_DISPLAY_STYLE_UNSPECIFIED Card_DisplayStyle = 0 // The header of the card appears at the bottom of the // sidebar, partially covering the current top card of the stack. Clicking // the header pops the card into the card stack. If the card has no header, // a generated header is used instead. Card_PEEK Card_DisplayStyle = 1 // Default value. The card is shown by replacing the view of the top card in // the card stack. Card_REPLACE Card_DisplayStyle = 2 )
func (Card_DisplayStyle) Descriptor ¶
func (Card_DisplayStyle) Descriptor() protoreflect.EnumDescriptor
func (Card_DisplayStyle) Enum ¶
func (x Card_DisplayStyle) Enum() *Card_DisplayStyle
func (Card_DisplayStyle) EnumDescriptor
deprecated
func (Card_DisplayStyle) EnumDescriptor() ([]byte, []int)
Deprecated: Use Card_DisplayStyle.Descriptor instead.
func (Card_DisplayStyle) Number ¶
func (x Card_DisplayStyle) Number() protoreflect.EnumNumber
func (Card_DisplayStyle) String ¶
func (x Card_DisplayStyle) String() string
func (Card_DisplayStyle) Type ¶
func (Card_DisplayStyle) Type() protoreflect.EnumType
type Card_DividerStyle ¶
type Card_DividerStyle int32
The divider style of a card. Currently only used for dividers betweens card sections.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
const ( // Don't use. Unspecified. Card_DIVIDER_STYLE_UNSPECIFIED Card_DividerStyle = 0 // Default option. Render a solid divider between sections. Card_SOLID_DIVIDER Card_DividerStyle = 1 // If set, no divider is rendered between sections. Card_NO_DIVIDER Card_DividerStyle = 2 )
func (Card_DividerStyle) Descriptor ¶
func (Card_DividerStyle) Descriptor() protoreflect.EnumDescriptor
func (Card_DividerStyle) Enum ¶
func (x Card_DividerStyle) Enum() *Card_DividerStyle
func (Card_DividerStyle) EnumDescriptor
deprecated
func (Card_DividerStyle) EnumDescriptor() ([]byte, []int)
Deprecated: Use Card_DividerStyle.Descriptor instead.
func (Card_DividerStyle) Number ¶
func (x Card_DividerStyle) Number() protoreflect.EnumNumber
func (Card_DividerStyle) String ¶
func (x Card_DividerStyle) String() string
func (Card_DividerStyle) Type ¶
func (Card_DividerStyle) Type() protoreflect.EnumType
type Card_Section ¶
type Card_Section struct { // Text that appears at the top of a section. // Supports simple HTML formatted text. For more information // about formatting text, see // [Formatting text in Google Chat // apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) // and // [Formatting // text in Google Workspace // Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). Header string `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"` // All the widgets in the section. // Must contain at least one widget. Widgets []*Widget `protobuf:"bytes,2,rep,name=widgets,proto3" json:"widgets,omitempty"` // Indicates whether this section is collapsible. // // Collapsible sections hide some or all widgets, but users can expand the // section to reveal the hidden widgets by clicking **Show more**. Users // can hide the widgets again by clicking **Show less**. // // To determine which widgets are hidden, specify // `uncollapsibleWidgetsCount`. Collapsible bool `protobuf:"varint,5,opt,name=collapsible,proto3" json:"collapsible,omitempty"` // The number of uncollapsible widgets which remain visible even when a // section is collapsed. // // For example, when a section // contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, // the first two widgets are always shown and the last three are collapsed // by default. The `uncollapsibleWidgetsCount` is taken into account only // when `collapsible` is `true`. UncollapsibleWidgetsCount int32 `` /* 139-byte string literal not displayed */ // contains filtered or unexported fields }
A section contains a collection of widgets that are rendered vertically in the order that they're specified.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
func (*Card_Section) Descriptor
deprecated
func (*Card_Section) Descriptor() ([]byte, []int)
Deprecated: Use Card_Section.ProtoReflect.Descriptor instead.
func (*Card_Section) GetCollapsible ¶
func (x *Card_Section) GetCollapsible() bool
func (*Card_Section) GetHeader ¶
func (x *Card_Section) GetHeader() string
func (*Card_Section) GetUncollapsibleWidgetsCount ¶
func (x *Card_Section) GetUncollapsibleWidgetsCount() int32
func (*Card_Section) GetWidgets ¶
func (x *Card_Section) GetWidgets() []*Widget
func (*Card_Section) ProtoMessage ¶
func (*Card_Section) ProtoMessage()
func (*Card_Section) ProtoReflect ¶
func (x *Card_Section) ProtoReflect() protoreflect.Message
func (*Card_Section) Reset ¶
func (x *Card_Section) Reset()
func (*Card_Section) String ¶
func (x *Card_Section) String() string
type Columns ¶
type Columns struct { // An array of columns. You can include up to 2 columns in a card or dialog. ColumnItems []*Columns_Column `protobuf:"bytes,2,rep,name=column_items,json=columnItems,proto3" json:"column_items,omitempty"` // contains filtered or unexported fields }
The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns).
The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns.
Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first:
- On web, the second column wraps if the screen width is less than or equal to 480 pixels.
- On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt.
- On Android devices, the second column wraps if the screen width is less than or equal to 320 dp.
To include more than 2 columns, or to use rows, use the [`Grid`][google.apps.card.v1.Grid] widget.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): Columns for Google Workspace Add-ons are in Developer Preview.
func (*Columns) Descriptor
deprecated
func (*Columns) GetColumnItems ¶
func (x *Columns) GetColumnItems() []*Columns_Column
func (*Columns) ProtoMessage ¶
func (*Columns) ProtoMessage()
func (*Columns) ProtoReflect ¶
func (x *Columns) ProtoReflect() protoreflect.Message
type Columns_Column ¶
type Columns_Column struct { // Specifies how a column fills the width of the card. HorizontalSizeStyle Columns_Column_HorizontalSizeStyle `` /* 181-byte string literal not displayed */ // Specifies whether widgets align to the left, right, or center of a // column. HorizontalAlignment Widget_HorizontalAlignment `` /* 171-byte string literal not displayed */ // Specifies whether widgets align to the top, bottom, or center of a // column. VerticalAlignment Columns_Column_VerticalAlignment `` /* 171-byte string literal not displayed */ // An array of widgets included in a column. Widgets appear in the order // that they are specified. Widgets []*Columns_Column_Widgets `protobuf:"bytes,4,rep,name=widgets,proto3" json:"widgets,omitempty"` // contains filtered or unexported fields }
A column.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): Columns for Google Workspace Add-ons are in Developer Preview.
func (*Columns_Column) Descriptor
deprecated
func (*Columns_Column) Descriptor() ([]byte, []int)
Deprecated: Use Columns_Column.ProtoReflect.Descriptor instead.
func (*Columns_Column) GetHorizontalAlignment ¶
func (x *Columns_Column) GetHorizontalAlignment() Widget_HorizontalAlignment
func (*Columns_Column) GetHorizontalSizeStyle ¶
func (x *Columns_Column) GetHorizontalSizeStyle() Columns_Column_HorizontalSizeStyle
func (*Columns_Column) GetVerticalAlignment ¶
func (x *Columns_Column) GetVerticalAlignment() Columns_Column_VerticalAlignment
func (*Columns_Column) GetWidgets ¶
func (x *Columns_Column) GetWidgets() []*Columns_Column_Widgets
func (*Columns_Column) ProtoMessage ¶
func (*Columns_Column) ProtoMessage()
func (*Columns_Column) ProtoReflect ¶
func (x *Columns_Column) ProtoReflect() protoreflect.Message
func (*Columns_Column) Reset ¶
func (x *Columns_Column) Reset()
func (*Columns_Column) String ¶
func (x *Columns_Column) String() string
type Columns_Column_HorizontalSizeStyle ¶
type Columns_Column_HorizontalSizeStyle int32
Specifies how a column fills the width of the card. The width of each column depends on both the `HorizontalSizeStyle` and the width of the widgets within the column.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): Columns for Google Workspace Add-ons are in Developer Preview.
const ( // Don't use. Unspecified. Columns_Column_HORIZONTAL_SIZE_STYLE_UNSPECIFIED Columns_Column_HorizontalSizeStyle = 0 // Default value. Column fills the available space, up to 70% of the // card's width. If both columns are set to `FILL_AVAILABLE_SPACE`, each // column fills 50% of the space. Columns_Column_FILL_AVAILABLE_SPACE Columns_Column_HorizontalSizeStyle = 1 // Column fills the least amount of space possible and no more than 30% of // the card's width. Columns_Column_FILL_MINIMUM_SPACE Columns_Column_HorizontalSizeStyle = 2 )
func (Columns_Column_HorizontalSizeStyle) Descriptor ¶
func (Columns_Column_HorizontalSizeStyle) Descriptor() protoreflect.EnumDescriptor
func (Columns_Column_HorizontalSizeStyle) Enum ¶
func (x Columns_Column_HorizontalSizeStyle) Enum() *Columns_Column_HorizontalSizeStyle
func (Columns_Column_HorizontalSizeStyle) EnumDescriptor
deprecated
func (Columns_Column_HorizontalSizeStyle) EnumDescriptor() ([]byte, []int)
Deprecated: Use Columns_Column_HorizontalSizeStyle.Descriptor instead.
func (Columns_Column_HorizontalSizeStyle) Number ¶
func (x Columns_Column_HorizontalSizeStyle) Number() protoreflect.EnumNumber
func (Columns_Column_HorizontalSizeStyle) String ¶
func (x Columns_Column_HorizontalSizeStyle) String() string
func (Columns_Column_HorizontalSizeStyle) Type ¶
func (Columns_Column_HorizontalSizeStyle) Type() protoreflect.EnumType
type Columns_Column_VerticalAlignment ¶
type Columns_Column_VerticalAlignment int32
Specifies whether widgets align to the top, bottom, or center of a column.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): Columns for Google Workspace Add-ons are in Developer Preview.
const ( // Don't use. Unspecified. Columns_Column_VERTICAL_ALIGNMENT_UNSPECIFIED Columns_Column_VerticalAlignment = 0 // Default value. Aligns widgets to the center of a column. Columns_Column_CENTER Columns_Column_VerticalAlignment = 1 // Aligns widgets to the top of a column. Columns_Column_TOP Columns_Column_VerticalAlignment = 2 // Aligns widgets to the bottom of a column. Columns_Column_BOTTOM Columns_Column_VerticalAlignment = 3 )
func (Columns_Column_VerticalAlignment) Descriptor ¶
func (Columns_Column_VerticalAlignment) Descriptor() protoreflect.EnumDescriptor
func (Columns_Column_VerticalAlignment) Enum ¶
func (x Columns_Column_VerticalAlignment) Enum() *Columns_Column_VerticalAlignment
func (Columns_Column_VerticalAlignment) EnumDescriptor
deprecated
func (Columns_Column_VerticalAlignment) EnumDescriptor() ([]byte, []int)
Deprecated: Use Columns_Column_VerticalAlignment.Descriptor instead.
func (Columns_Column_VerticalAlignment) Number ¶
func (x Columns_Column_VerticalAlignment) Number() protoreflect.EnumNumber
func (Columns_Column_VerticalAlignment) String ¶
func (x Columns_Column_VerticalAlignment) String() string
func (Columns_Column_VerticalAlignment) Type ¶
func (Columns_Column_VerticalAlignment) Type() protoreflect.EnumType
type Columns_Column_Widgets ¶
type Columns_Column_Widgets struct { // Types that are assignable to Data: // // *Columns_Column_Widgets_TextParagraph // *Columns_Column_Widgets_Image // *Columns_Column_Widgets_DecoratedText // *Columns_Column_Widgets_ButtonList // *Columns_Column_Widgets_TextInput // *Columns_Column_Widgets_SelectionInput // *Columns_Column_Widgets_DateTimePicker Data isColumns_Column_Widgets_Data `protobuf_oneof:"data"` // contains filtered or unexported fields }
The supported widgets that you can include in a column.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): Columns for Google Workspace Add-ons are in Developer Preview.
func (*Columns_Column_Widgets) Descriptor
deprecated
func (*Columns_Column_Widgets) Descriptor() ([]byte, []int)
Deprecated: Use Columns_Column_Widgets.ProtoReflect.Descriptor instead.
func (*Columns_Column_Widgets) GetButtonList ¶
func (x *Columns_Column_Widgets) GetButtonList() *ButtonList
func (*Columns_Column_Widgets) GetData ¶
func (m *Columns_Column_Widgets) GetData() isColumns_Column_Widgets_Data
func (*Columns_Column_Widgets) GetDateTimePicker ¶
func (x *Columns_Column_Widgets) GetDateTimePicker() *DateTimePicker
func (*Columns_Column_Widgets) GetDecoratedText ¶
func (x *Columns_Column_Widgets) GetDecoratedText() *DecoratedText
func (*Columns_Column_Widgets) GetImage ¶
func (x *Columns_Column_Widgets) GetImage() *Image
func (*Columns_Column_Widgets) GetSelectionInput ¶
func (x *Columns_Column_Widgets) GetSelectionInput() *SelectionInput
func (*Columns_Column_Widgets) GetTextInput ¶
func (x *Columns_Column_Widgets) GetTextInput() *TextInput
func (*Columns_Column_Widgets) GetTextParagraph ¶
func (x *Columns_Column_Widgets) GetTextParagraph() *TextParagraph
func (*Columns_Column_Widgets) ProtoMessage ¶
func (*Columns_Column_Widgets) ProtoMessage()
func (*Columns_Column_Widgets) ProtoReflect ¶
func (x *Columns_Column_Widgets) ProtoReflect() protoreflect.Message
func (*Columns_Column_Widgets) Reset ¶
func (x *Columns_Column_Widgets) Reset()
func (*Columns_Column_Widgets) String ¶
func (x *Columns_Column_Widgets) String() string
type Columns_Column_Widgets_ButtonList ¶
type Columns_Column_Widgets_ButtonList struct { // [ButtonList][google.apps.card.v1.ButtonList] widget. ButtonList *ButtonList `protobuf:"bytes,4,opt,name=button_list,json=buttonList,proto3,oneof"` }
type Columns_Column_Widgets_DateTimePicker ¶
type Columns_Column_Widgets_DateTimePicker struct { // [DateTimePicker][google.apps.card.v1.DateTimePicker] widget. DateTimePicker *DateTimePicker `protobuf:"bytes,7,opt,name=date_time_picker,json=dateTimePicker,proto3,oneof"` }
type Columns_Column_Widgets_DecoratedText ¶
type Columns_Column_Widgets_DecoratedText struct { // [DecoratedText][google.apps.card.v1.DecoratedText] widget. DecoratedText *DecoratedText `protobuf:"bytes,3,opt,name=decorated_text,json=decoratedText,proto3,oneof"` }
type Columns_Column_Widgets_Image ¶
type Columns_Column_Widgets_Image struct { // [Image][google.apps.card.v1.Image] widget. Image *Image `protobuf:"bytes,2,opt,name=image,proto3,oneof"` }
type Columns_Column_Widgets_SelectionInput ¶
type Columns_Column_Widgets_SelectionInput struct { // [SelectionInput][google.apps.card.v1.SelectionInput] widget. SelectionInput *SelectionInput `protobuf:"bytes,6,opt,name=selection_input,json=selectionInput,proto3,oneof"` }
type Columns_Column_Widgets_TextInput ¶
type Columns_Column_Widgets_TextInput struct { // [TextInput][google.apps.card.v1.TextInput] widget. TextInput *TextInput `protobuf:"bytes,5,opt,name=text_input,json=textInput,proto3,oneof"` }
type Columns_Column_Widgets_TextParagraph ¶
type Columns_Column_Widgets_TextParagraph struct { // [TextParagraph][google.apps.card.v1.TextParagraph] widget. TextParagraph *TextParagraph `protobuf:"bytes,1,opt,name=text_paragraph,json=textParagraph,proto3,oneof"` }
type DateTimePicker ¶
type DateTimePicker struct { // The name by which the `DateTimePicker` is identified in a form input event. // // For details about working with form inputs, see [Receive form // data](https://developers.google.com/workspace/chat/read-form-data). Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // The text that prompts users to input a date, a time, or a date and time. // For example, if users are scheduling an appointment, use a label such as // `Appointment date` or `Appointment date and time`. Label string `protobuf:"bytes,2,opt,name=label,proto3" json:"label,omitempty"` // Whether the widget supports inputting a date, a time, or the date and time. Type DateTimePicker_DateTimePickerType `protobuf:"varint,3,opt,name=type,proto3,enum=google.apps.card.v1.DateTimePicker_DateTimePickerType" json:"type,omitempty"` // The default value displayed in the widget, in milliseconds since [Unix // epoch time](https://en.wikipedia.org/wiki/Unix_time). // // Specify the value based on the type of picker (`DateTimePickerType`): // // - `DATE_AND_TIME`: a calendar date and time in UTC. For example, to // represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. // - `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent // January 1, 2023, use `1672531200000`. // - `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use // `43200000` (or `12 * 60 * 60 * 1000`). ValueMsEpoch int64 `protobuf:"varint,4,opt,name=value_ms_epoch,json=valueMsEpoch,proto3" json:"value_ms_epoch,omitempty"` // The number representing the time zone offset from UTC, in minutes. // If set, the `value_ms_epoch` is displayed in the specified time zone. // If unset, the value defaults to the user's time zone setting. TimezoneOffsetDate int32 `protobuf:"varint,5,opt,name=timezone_offset_date,json=timezoneOffsetDate,proto3" json:"timezone_offset_date,omitempty"` // Triggered when the user clicks **Save** or **Clear** from the // `DateTimePicker` interface. OnChangeAction *Action `protobuf:"bytes,6,opt,name=on_change_action,json=onChangeAction,proto3" json:"on_change_action,omitempty"` // contains filtered or unexported fields }
Lets users input a date, a time, or both a date and a time. For an example in Google Chat apps, see [Let a user pick a date and time](https://developers.google.com/workspace/chat/design-interactive-card-dialog#let_a_user_pick_a_date_and_time).
Users can input text or use the picker to select dates and times. If users input an invalid date or time, the picker shows an error that prompts users to input the information correctly.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
func (*DateTimePicker) Descriptor
deprecated
func (*DateTimePicker) Descriptor() ([]byte, []int)
Deprecated: Use DateTimePicker.ProtoReflect.Descriptor instead.
func (*DateTimePicker) GetLabel ¶
func (x *DateTimePicker) GetLabel() string
func (*DateTimePicker) GetName ¶
func (x *DateTimePicker) GetName() string
func (*DateTimePicker) GetOnChangeAction ¶
func (x *DateTimePicker) GetOnChangeAction() *Action
func (*DateTimePicker) GetTimezoneOffsetDate ¶
func (x *DateTimePicker) GetTimezoneOffsetDate() int32
func (*DateTimePicker) GetType ¶
func (x *DateTimePicker) GetType() DateTimePicker_DateTimePickerType
func (*DateTimePicker) GetValueMsEpoch ¶
func (x *DateTimePicker) GetValueMsEpoch() int64
func (*DateTimePicker) ProtoMessage ¶
func (*DateTimePicker) ProtoMessage()
func (*DateTimePicker) ProtoReflect ¶
func (x *DateTimePicker) ProtoReflect() protoreflect.Message
func (*DateTimePicker) Reset ¶
func (x *DateTimePicker) Reset()
func (*DateTimePicker) String ¶
func (x *DateTimePicker) String() string
type DateTimePicker_DateTimePickerType ¶
type DateTimePicker_DateTimePickerType int32
The format for the date and time in the `DateTimePicker` widget. Determines whether users can input a date, a time, or both a date and time.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
const ( // Users input a date and time. DateTimePicker_DATE_AND_TIME DateTimePicker_DateTimePickerType = 0 // Users input a date. DateTimePicker_DATE_ONLY DateTimePicker_DateTimePickerType = 1 // Users input a time. DateTimePicker_TIME_ONLY DateTimePicker_DateTimePickerType = 2 )
func (DateTimePicker_DateTimePickerType) Descriptor ¶
func (DateTimePicker_DateTimePickerType) Descriptor() protoreflect.EnumDescriptor
func (DateTimePicker_DateTimePickerType) Enum ¶
func (x DateTimePicker_DateTimePickerType) Enum() *DateTimePicker_DateTimePickerType
func (DateTimePicker_DateTimePickerType) EnumDescriptor
deprecated
func (DateTimePicker_DateTimePickerType) EnumDescriptor() ([]byte, []int)
Deprecated: Use DateTimePicker_DateTimePickerType.Descriptor instead.
func (DateTimePicker_DateTimePickerType) Number ¶
func (x DateTimePicker_DateTimePickerType) Number() protoreflect.EnumNumber
func (DateTimePicker_DateTimePickerType) String ¶
func (x DateTimePicker_DateTimePickerType) String() string
func (DateTimePicker_DateTimePickerType) Type ¶
func (DateTimePicker_DateTimePickerType) Type() protoreflect.EnumType
type DecoratedText ¶
type DecoratedText struct { // Deprecated in favor of `startIcon`. // // Deprecated: Do not use. Icon *Icon `protobuf:"bytes,1,opt,name=icon,proto3" json:"icon,omitempty"` // The icon displayed in front of the text. StartIcon *Icon `protobuf:"bytes,12,opt,name=start_icon,json=startIcon,proto3" json:"start_icon,omitempty"` // The text that appears above `text`. Always truncates. TopLabel string `protobuf:"bytes,3,opt,name=top_label,json=topLabel,proto3" json:"top_label,omitempty"` // Required. The primary text. // // Supports simple formatting. For more information // about formatting text, see // [Formatting text in Google Chat // apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) // and // [Formatting // text in Google Workspace // Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). Text string `protobuf:"bytes,4,opt,name=text,proto3" json:"text,omitempty"` // The wrap text setting. If `true`, the text wraps and displays on // multiple lines. Otherwise, the text is truncated. // // Only applies to `text`, not `topLabel` and `bottomLabel`. WrapText bool `protobuf:"varint,5,opt,name=wrap_text,json=wrapText,proto3" json:"wrap_text,omitempty"` // The text that appears below `text`. Always wraps. BottomLabel string `protobuf:"bytes,6,opt,name=bottom_label,json=bottomLabel,proto3" json:"bottom_label,omitempty"` // This action is triggered when users click `topLabel` or `bottomLabel`. OnClick *OnClick `protobuf:"bytes,7,opt,name=on_click,json=onClick,proto3" json:"on_click,omitempty"` // A button, switch, checkbox, or image that appears to the right-hand side // of text in the `decoratedText` widget. // // Types that are assignable to Control: // // *DecoratedText_Button // *DecoratedText_SwitchControl_ // *DecoratedText_EndIcon Control isDecoratedText_Control `protobuf_oneof:"control"` // contains filtered or unexported fields }
A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements).
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
func (*DecoratedText) Descriptor
deprecated
func (*DecoratedText) Descriptor() ([]byte, []int)
Deprecated: Use DecoratedText.ProtoReflect.Descriptor instead.
func (*DecoratedText) GetBottomLabel ¶
func (x *DecoratedText) GetBottomLabel() string
func (*DecoratedText) GetButton ¶
func (x *DecoratedText) GetButton() *Button
func (*DecoratedText) GetControl ¶
func (m *DecoratedText) GetControl() isDecoratedText_Control
func (*DecoratedText) GetEndIcon ¶
func (x *DecoratedText) GetEndIcon() *Icon
func (*DecoratedText) GetIcon
deprecated
func (x *DecoratedText) GetIcon() *Icon
Deprecated: Do not use.
func (*DecoratedText) GetOnClick ¶
func (x *DecoratedText) GetOnClick() *OnClick
func (*DecoratedText) GetStartIcon ¶
func (x *DecoratedText) GetStartIcon() *Icon
func (*DecoratedText) GetSwitchControl ¶
func (x *DecoratedText) GetSwitchControl() *DecoratedText_SwitchControl
func (*DecoratedText) GetText ¶
func (x *DecoratedText) GetText() string
func (*DecoratedText) GetTopLabel ¶
func (x *DecoratedText) GetTopLabel() string
func (*DecoratedText) GetWrapText ¶
func (x *DecoratedText) GetWrapText() bool
func (*DecoratedText) ProtoMessage ¶
func (*DecoratedText) ProtoMessage()
func (*DecoratedText) ProtoReflect ¶
func (x *DecoratedText) ProtoReflect() protoreflect.Message
func (*DecoratedText) Reset ¶
func (x *DecoratedText) Reset()
func (*DecoratedText) String ¶
func (x *DecoratedText) String() string
type DecoratedText_Button ¶
type DecoratedText_Button struct { // A button that a user can click to trigger an action. Button *Button `protobuf:"bytes,8,opt,name=button,proto3,oneof"` }
type DecoratedText_EndIcon ¶
type DecoratedText_EndIcon struct { // An icon displayed after the text. // // Supports // [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) // and // [custom](https://developers.google.com/workspace/chat/format-messages#customicons) // icons. EndIcon *Icon `protobuf:"bytes,11,opt,name=end_icon,json=endIcon,proto3,oneof"` }
type DecoratedText_SwitchControl ¶
type DecoratedText_SwitchControl struct { // The name by which the switch widget is identified in a form input event. // // For details about working with form inputs, see [Receive form // data](https://developers.google.com/workspace/chat/read-form-data). Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // The value entered by a user, returned as part of a form input event. // // For details about working with form inputs, see [Receive form // data](https://developers.google.com/workspace/chat/read-form-data). Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // When `true`, the switch is selected. Selected bool `protobuf:"varint,3,opt,name=selected,proto3" json:"selected,omitempty"` // The action to perform when the switch state is changed, such as what // // function to run. OnChangeAction *Action `protobuf:"bytes,4,opt,name=on_change_action,json=onChangeAction,proto3" json:"on_change_action,omitempty"` // How the switch appears in the user interface. // // [Google Workspace Add-ons // and Chat apps](https://developers.google.com/workspace/extend): ControlType DecoratedText_SwitchControl_ControlType `` /* 160-byte string literal not displayed */ // contains filtered or unexported fields }
Either a toggle-style switch or a checkbox inside a `decoratedText` widget.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
Only supported in the `decoratedText` widget.
func (*DecoratedText_SwitchControl) Descriptor
deprecated
func (*DecoratedText_SwitchControl) Descriptor() ([]byte, []int)
Deprecated: Use DecoratedText_SwitchControl.ProtoReflect.Descriptor instead.
func (*DecoratedText_SwitchControl) GetControlType ¶
func (x *DecoratedText_SwitchControl) GetControlType() DecoratedText_SwitchControl_ControlType
func (*DecoratedText_SwitchControl) GetName ¶
func (x *DecoratedText_SwitchControl) GetName() string
func (*DecoratedText_SwitchControl) GetOnChangeAction ¶
func (x *DecoratedText_SwitchControl) GetOnChangeAction() *Action
func (*DecoratedText_SwitchControl) GetSelected ¶
func (x *DecoratedText_SwitchControl) GetSelected() bool
func (*DecoratedText_SwitchControl) GetValue ¶
func (x *DecoratedText_SwitchControl) GetValue() string
func (*DecoratedText_SwitchControl) ProtoMessage ¶
func (*DecoratedText_SwitchControl) ProtoMessage()
func (*DecoratedText_SwitchControl) ProtoReflect ¶
func (x *DecoratedText_SwitchControl) ProtoReflect() protoreflect.Message
func (*DecoratedText_SwitchControl) Reset ¶
func (x *DecoratedText_SwitchControl) Reset()
func (*DecoratedText_SwitchControl) String ¶
func (x *DecoratedText_SwitchControl) String() string
type DecoratedText_SwitchControl_ ¶
type DecoratedText_SwitchControl_ struct { // A switch widget that a user can click to change its state and trigger an // action. SwitchControl *DecoratedText_SwitchControl `protobuf:"bytes,9,opt,name=switch_control,json=switchControl,proto3,oneof"` }
type DecoratedText_SwitchControl_ControlType ¶
type DecoratedText_SwitchControl_ControlType int32
How the switch appears in the user interface.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
const ( // A toggle-style switch. DecoratedText_SwitchControl_SWITCH DecoratedText_SwitchControl_ControlType = 0 // Deprecated in favor of `CHECK_BOX`. DecoratedText_SwitchControl_CHECKBOX DecoratedText_SwitchControl_ControlType = 1 // A checkbox. DecoratedText_SwitchControl_CHECK_BOX DecoratedText_SwitchControl_ControlType = 2 )
func (DecoratedText_SwitchControl_ControlType) Descriptor ¶
func (DecoratedText_SwitchControl_ControlType) Descriptor() protoreflect.EnumDescriptor
func (DecoratedText_SwitchControl_ControlType) EnumDescriptor
deprecated
func (DecoratedText_SwitchControl_ControlType) EnumDescriptor() ([]byte, []int)
Deprecated: Use DecoratedText_SwitchControl_ControlType.Descriptor instead.
func (DecoratedText_SwitchControl_ControlType) Number ¶
func (x DecoratedText_SwitchControl_ControlType) Number() protoreflect.EnumNumber
func (DecoratedText_SwitchControl_ControlType) String ¶
func (x DecoratedText_SwitchControl_ControlType) String() string
func (DecoratedText_SwitchControl_ControlType) Type ¶
func (DecoratedText_SwitchControl_ControlType) Type() protoreflect.EnumType
type Divider ¶
type Divider struct {
// contains filtered or unexported fields
}
Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets).
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
For example, the following JSON creates a divider:
``` "divider": {} ```
func (*Divider) Descriptor
deprecated
func (*Divider) ProtoMessage ¶
func (*Divider) ProtoMessage()
func (*Divider) ProtoReflect ¶
func (x *Divider) ProtoReflect() protoreflect.Message
type Grid ¶
type Grid struct { // The text that displays in the grid header. Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"` // The items to display in the grid. Items []*Grid_GridItem `protobuf:"bytes,2,rep,name=items,proto3" json:"items,omitempty"` // The border style to apply to each grid item. BorderStyle *BorderStyle `protobuf:"bytes,3,opt,name=border_style,json=borderStyle,proto3" json:"border_style,omitempty"` // The number of columns to display in the grid. A default value // is used if this field isn't specified, and that default value is // different depending on where the grid is shown (dialog versus companion). ColumnCount int32 `protobuf:"varint,4,opt,name=column_count,json=columnCount,proto3" json:"column_count,omitempty"` // This callback is reused by each individual grid item, but with the // item's identifier and index in the items list added to the callback's // parameters. OnClick *OnClick `protobuf:"bytes,5,opt,name=on_click,json=onClick,proto3" json:"on_click,omitempty"` // contains filtered or unexported fields }
Displays a grid with a collection of items. Items can only include text or images. For responsive columns, or to include more than text or images, use [`Columns`][google.apps.card.v1.Columns]. For an example in Google Chat apps, see [Display a Grid with a collection of items](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_a_grid_with_a_collection_of_items).
A grid supports any number of columns and items. The number of rows is determined by items divided by columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 items and 2 columns has 6 rows.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
For example, the following JSON creates a 2 column grid with a single item:
```
"grid": { "title": "A fine collection of items", "columnCount": 2, "borderStyle": { "type": "STROKE", "cornerRadius": 4 }, "items": [ { "image": { "imageUri": "https://www.example.com/image.png", "cropStyle": { "type": "SQUARE" }, "borderStyle": { "type": "STROKE" } }, "title": "An item", "textAlignment": "CENTER" } ], "onClick": { "openLink": { "url": "https://www.example.com" } } }
```
func (*Grid) Descriptor
deprecated
func (*Grid) GetBorderStyle ¶
func (x *Grid) GetBorderStyle() *BorderStyle
func (*Grid) GetColumnCount ¶
func (*Grid) GetItems ¶
func (x *Grid) GetItems() []*Grid_GridItem
func (*Grid) GetOnClick ¶
func (*Grid) ProtoMessage ¶
func (*Grid) ProtoMessage()
func (*Grid) ProtoReflect ¶
func (x *Grid) ProtoReflect() protoreflect.Message
type Grid_GridItem ¶
type Grid_GridItem struct { // A user-specified identifier for this grid item. This identifier is // returned in the parent grid's `onClick` callback parameters. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // The image that displays in the grid item. Image *ImageComponent `protobuf:"bytes,2,opt,name=image,proto3" json:"image,omitempty"` // The grid item's title. Title string `protobuf:"bytes,3,opt,name=title,proto3" json:"title,omitempty"` // The grid item's subtitle. Subtitle string `protobuf:"bytes,4,opt,name=subtitle,proto3" json:"subtitle,omitempty"` // The layout to use for the grid item. Layout Grid_GridItem_GridItemLayout `protobuf:"varint,9,opt,name=layout,proto3,enum=google.apps.card.v1.Grid_GridItem_GridItemLayout" json:"layout,omitempty"` // contains filtered or unexported fields }
Represents an item in a grid layout. Items can contain text, an image, or both text and an image.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
func (*Grid_GridItem) Descriptor
deprecated
func (*Grid_GridItem) Descriptor() ([]byte, []int)
Deprecated: Use Grid_GridItem.ProtoReflect.Descriptor instead.
func (*Grid_GridItem) GetId ¶
func (x *Grid_GridItem) GetId() string
func (*Grid_GridItem) GetImage ¶
func (x *Grid_GridItem) GetImage() *ImageComponent
func (*Grid_GridItem) GetLayout ¶
func (x *Grid_GridItem) GetLayout() Grid_GridItem_GridItemLayout
func (*Grid_GridItem) GetSubtitle ¶
func (x *Grid_GridItem) GetSubtitle() string
func (*Grid_GridItem) GetTitle ¶
func (x *Grid_GridItem) GetTitle() string
func (*Grid_GridItem) ProtoMessage ¶
func (*Grid_GridItem) ProtoMessage()
func (*Grid_GridItem) ProtoReflect ¶
func (x *Grid_GridItem) ProtoReflect() protoreflect.Message
func (*Grid_GridItem) Reset ¶
func (x *Grid_GridItem) Reset()
func (*Grid_GridItem) String ¶
func (x *Grid_GridItem) String() string
type Grid_GridItem_GridItemLayout ¶
type Grid_GridItem_GridItemLayout int32
Represents the various layout options available for a grid item.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
const ( // Don't use. Unspecified. Grid_GridItem_GRID_ITEM_LAYOUT_UNSPECIFIED Grid_GridItem_GridItemLayout = 0 // The title and subtitle are shown below the grid item's image. Grid_GridItem_TEXT_BELOW Grid_GridItem_GridItemLayout = 1 // The title and subtitle are shown above the grid item's image. Grid_GridItem_TEXT_ABOVE Grid_GridItem_GridItemLayout = 2 )
func (Grid_GridItem_GridItemLayout) Descriptor ¶
func (Grid_GridItem_GridItemLayout) Descriptor() protoreflect.EnumDescriptor
func (Grid_GridItem_GridItemLayout) Enum ¶
func (x Grid_GridItem_GridItemLayout) Enum() *Grid_GridItem_GridItemLayout
func (Grid_GridItem_GridItemLayout) EnumDescriptor
deprecated
func (Grid_GridItem_GridItemLayout) EnumDescriptor() ([]byte, []int)
Deprecated: Use Grid_GridItem_GridItemLayout.Descriptor instead.
func (Grid_GridItem_GridItemLayout) Number ¶
func (x Grid_GridItem_GridItemLayout) Number() protoreflect.EnumNumber
func (Grid_GridItem_GridItemLayout) String ¶
func (x Grid_GridItem_GridItemLayout) String() string
func (Grid_GridItem_GridItemLayout) Type ¶
func (Grid_GridItem_GridItemLayout) Type() protoreflect.EnumType
type Icon ¶
type Icon struct { // The icon displayed in the widget on the card. // // Types that are assignable to Icons: // // *Icon_KnownIcon // *Icon_IconUrl // *Icon_MaterialIcon Icons isIcon_Icons `protobuf_oneof:"icons"` // Optional. A description of the icon used for accessibility. // If unspecified, the default value `Button` is provided. As a best practice, // you should set a helpful description for what the icon displays, and if // applicable, what it does. For example, `A user's account portrait`, or // `Opens a new browser tab and navigates to the Google Chat developer // documentation at https://developers.google.com/workspace/chat`. // // If the icon is set in a [`Button`][google.apps.card.v1.Button], the // `altText` appears as helper text when the user hovers over the button. // However, if the button also sets `text`, the icon's `altText` is ignored. AltText string `protobuf:"bytes,3,opt,name=alt_text,json=altText,proto3" json:"alt_text,omitempty"` // The crop style applied to the image. In some cases, applying a // `CIRCLE` crop causes the image to be drawn larger than a built-in // icon. ImageType Widget_ImageType `` /* 131-byte string literal not displayed */ // contains filtered or unexported fields }
An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon).
Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
func (*Icon) Descriptor
deprecated
func (*Icon) GetAltText ¶
func (*Icon) GetIconUrl ¶
func (*Icon) GetImageType ¶
func (x *Icon) GetImageType() Widget_ImageType
func (*Icon) GetKnownIcon ¶
func (*Icon) GetMaterialIcon ¶
func (x *Icon) GetMaterialIcon() *MaterialIcon
func (*Icon) ProtoMessage ¶
func (*Icon) ProtoMessage()
func (*Icon) ProtoReflect ¶
func (x *Icon) ProtoReflect() protoreflect.Message
type Icon_IconUrl ¶
type Icon_IconUrl struct { // Display a custom icon hosted at an HTTPS URL. // // For example: // // “` // "iconUrl": // "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" // “` // // Supported file types include `.png` and `.jpg`. IconUrl string `protobuf:"bytes,2,opt,name=icon_url,json=iconUrl,proto3,oneof"` }
type Icon_KnownIcon ¶
type Icon_KnownIcon struct { // Display one of the built-in icons provided by Google Workspace. // // For example, to display an airplane icon, specify `AIRPLANE`. // For a bus, specify `BUS`. // // For a full list of supported icons, see [built-in // icons](https://developers.google.com/workspace/chat/format-messages#builtinicons). KnownIcon string `protobuf:"bytes,1,opt,name=known_icon,json=knownIcon,proto3,oneof"` }
type Icon_MaterialIcon ¶
type Icon_MaterialIcon struct { // Display one of the [Google Material // Icons](https://fonts.google.com/icons). // // For example, to display a [checkbox // icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048), // use // “` // // "material_icon": { // "name": "check_box" // } // // “` // // [Google Chat apps](https://developers.google.com/workspace/chat): MaterialIcon *MaterialIcon `protobuf:"bytes,5,opt,name=material_icon,json=materialIcon,proto3,oneof"` }
type Image ¶
type Image struct { // The HTTPS URL that hosts the image. // // For example: // // “` // https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png // “` ImageUrl string `protobuf:"bytes,1,opt,name=image_url,json=imageUrl,proto3" json:"image_url,omitempty"` // When a user clicks the image, the click triggers this action. OnClick *OnClick `protobuf:"bytes,2,opt,name=on_click,json=onClick,proto3" json:"on_click,omitempty"` // The alternative text of this image that's used for accessibility. AltText string `protobuf:"bytes,3,opt,name=alt_text,json=altText,proto3" json:"alt_text,omitempty"` // contains filtered or unexported fields }
An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image).
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
func (*Image) Descriptor
deprecated
func (*Image) GetAltText ¶
func (*Image) GetImageUrl ¶
func (*Image) GetOnClick ¶
func (*Image) ProtoMessage ¶
func (*Image) ProtoMessage()
func (*Image) ProtoReflect ¶
func (x *Image) ProtoReflect() protoreflect.Message
type ImageComponent ¶
type ImageComponent struct { // The image URL. ImageUri string `protobuf:"bytes,1,opt,name=image_uri,json=imageUri,proto3" json:"image_uri,omitempty"` // The accessibility label for the image. AltText string `protobuf:"bytes,2,opt,name=alt_text,json=altText,proto3" json:"alt_text,omitempty"` // The crop style to apply to the image. CropStyle *ImageCropStyle `protobuf:"bytes,3,opt,name=crop_style,json=cropStyle,proto3" json:"crop_style,omitempty"` // The border style to apply to the image. BorderStyle *BorderStyle `protobuf:"bytes,4,opt,name=border_style,json=borderStyle,proto3" json:"border_style,omitempty"` // contains filtered or unexported fields }
Represents an image.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
func (*ImageComponent) Descriptor
deprecated
func (*ImageComponent) Descriptor() ([]byte, []int)
Deprecated: Use ImageComponent.ProtoReflect.Descriptor instead.
func (*ImageComponent) GetAltText ¶
func (x *ImageComponent) GetAltText() string
func (*ImageComponent) GetBorderStyle ¶
func (x *ImageComponent) GetBorderStyle() *BorderStyle
func (*ImageComponent) GetCropStyle ¶
func (x *ImageComponent) GetCropStyle() *ImageCropStyle
func (*ImageComponent) GetImageUri ¶
func (x *ImageComponent) GetImageUri() string
func (*ImageComponent) ProtoMessage ¶
func (*ImageComponent) ProtoMessage()
func (*ImageComponent) ProtoReflect ¶
func (x *ImageComponent) ProtoReflect() protoreflect.Message
func (*ImageComponent) Reset ¶
func (x *ImageComponent) Reset()
func (*ImageComponent) String ¶
func (x *ImageComponent) String() string
type ImageCropStyle ¶
type ImageCropStyle struct { // The crop type. Type ImageCropStyle_ImageCropType `protobuf:"varint,1,opt,name=type,proto3,enum=google.apps.card.v1.ImageCropStyle_ImageCropType" json:"type,omitempty"` // The aspect ratio to use if the crop type is `RECTANGLE_CUSTOM`. // // For example, here's how to apply a 16:9 aspect ratio: // // “` // // cropStyle { // "type": "RECTANGLE_CUSTOM", // "aspectRatio": 16/9 // } // // “` AspectRatio float64 `protobuf:"fixed64,2,opt,name=aspect_ratio,json=aspectRatio,proto3" json:"aspect_ratio,omitempty"` // contains filtered or unexported fields }
Represents the crop style applied to an image.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
For example, here's how to apply a 16:9 aspect ratio:
```
cropStyle { "type": "RECTANGLE_CUSTOM", "aspectRatio": 16/9 }
```
func (*ImageCropStyle) Descriptor
deprecated
func (*ImageCropStyle) Descriptor() ([]byte, []int)
Deprecated: Use ImageCropStyle.ProtoReflect.Descriptor instead.
func (*ImageCropStyle) GetAspectRatio ¶
func (x *ImageCropStyle) GetAspectRatio() float64
func (*ImageCropStyle) GetType ¶
func (x *ImageCropStyle) GetType() ImageCropStyle_ImageCropType
func (*ImageCropStyle) ProtoMessage ¶
func (*ImageCropStyle) ProtoMessage()
func (*ImageCropStyle) ProtoReflect ¶
func (x *ImageCropStyle) ProtoReflect() protoreflect.Message
func (*ImageCropStyle) Reset ¶
func (x *ImageCropStyle) Reset()
func (*ImageCropStyle) String ¶
func (x *ImageCropStyle) String() string
type ImageCropStyle_ImageCropType ¶
type ImageCropStyle_ImageCropType int32
Represents the crop style applied to an image.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
const ( // Don't use. Unspecified. ImageCropStyle_IMAGE_CROP_TYPE_UNSPECIFIED ImageCropStyle_ImageCropType = 0 // Default value. Applies a square crop. ImageCropStyle_SQUARE ImageCropStyle_ImageCropType = 1 // Applies a circular crop. ImageCropStyle_CIRCLE ImageCropStyle_ImageCropType = 2 // Applies a rectangular crop with a custom aspect ratio. Set the custom // aspect ratio with `aspectRatio`. ImageCropStyle_RECTANGLE_CUSTOM ImageCropStyle_ImageCropType = 3 // Applies a rectangular crop with a 4:3 aspect ratio. ImageCropStyle_RECTANGLE_4_3 ImageCropStyle_ImageCropType = 4 )
func (ImageCropStyle_ImageCropType) Descriptor ¶
func (ImageCropStyle_ImageCropType) Descriptor() protoreflect.EnumDescriptor
func (ImageCropStyle_ImageCropType) Enum ¶
func (x ImageCropStyle_ImageCropType) Enum() *ImageCropStyle_ImageCropType
func (ImageCropStyle_ImageCropType) EnumDescriptor
deprecated
func (ImageCropStyle_ImageCropType) EnumDescriptor() ([]byte, []int)
Deprecated: Use ImageCropStyle_ImageCropType.Descriptor instead.
func (ImageCropStyle_ImageCropType) Number ¶
func (x ImageCropStyle_ImageCropType) Number() protoreflect.EnumNumber
func (ImageCropStyle_ImageCropType) String ¶
func (x ImageCropStyle_ImageCropType) String() string
func (ImageCropStyle_ImageCropType) Type ¶
func (ImageCropStyle_ImageCropType) Type() protoreflect.EnumType
type MaterialIcon ¶
type MaterialIcon struct { // The icon name defined in the [Google Material // Icon](https://fonts.google.com/icons), for example, `check_box`. Any // invalid names are abandoned and replaced with empty string and // results in the icon failing to render. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Whether the icon renders as filled. Default value is false. // // To preview different icon settings, go to // [Google Font Icons](https://fonts.google.com/icons) and adjust the // settings under **Customize**. Fill bool `protobuf:"varint,2,opt,name=fill,proto3" json:"fill,omitempty"` // The stroke weight of the icon. Choose from {100, 200, 300, 400, // 500, 600, 700}. If absent, default value is 400. If any other value is // specified, the default value is used. // // To preview different icon settings, go to // [Google Font Icons](https://fonts.google.com/icons) and adjust the // settings under **Customize**. Weight int32 `protobuf:"varint,3,opt,name=weight,proto3" json:"weight,omitempty"` // Weight and grade affect a symbol’s thickness. Adjustments to grade are more // granular than adjustments to weight and have a small impact on the size of // the symbol. Choose from {-25, 0, 200}. If absent, default value is 0. If // any other value is specified, the default value is used. // // To preview different icon settings, go to // [Google Font Icons](https://fonts.google.com/icons) and adjust the // settings under **Customize**. Grade int32 `protobuf:"varint,4,opt,name=grade,proto3" json:"grade,omitempty"` // contains filtered or unexported fields }
A [Google Material Icon](https://fonts.google.com/icons), which includes over 2500+ options.
For example, to display a [checkbox icon](https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Acheck_box%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048) with customized weight and grade, write the following:
```
{ "name": "check_box", "fill": true, "weight": 300, "grade": -25 }
```
[Google Chat apps](https://developers.google.com/workspace/chat):
func (*MaterialIcon) Descriptor
deprecated
func (*MaterialIcon) Descriptor() ([]byte, []int)
Deprecated: Use MaterialIcon.ProtoReflect.Descriptor instead.
func (*MaterialIcon) GetFill ¶
func (x *MaterialIcon) GetFill() bool
func (*MaterialIcon) GetGrade ¶
func (x *MaterialIcon) GetGrade() int32
func (*MaterialIcon) GetName ¶
func (x *MaterialIcon) GetName() string
func (*MaterialIcon) GetWeight ¶
func (x *MaterialIcon) GetWeight() int32
func (*MaterialIcon) ProtoMessage ¶
func (*MaterialIcon) ProtoMessage()
func (*MaterialIcon) ProtoReflect ¶
func (x *MaterialIcon) ProtoReflect() protoreflect.Message
func (*MaterialIcon) Reset ¶
func (x *MaterialIcon) Reset()
func (*MaterialIcon) String ¶
func (x *MaterialIcon) String() string
type OnClick ¶
type OnClick struct { // Types that are assignable to Data: // // *OnClick_Action // *OnClick_OpenLink // *OnClick_OpenDynamicLinkAction // *OnClick_Card Data isOnClick_Data `protobuf_oneof:"data"` // contains filtered or unexported fields }
Represents how to respond when users click an interactive element on a card, such as a button.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
func (*OnClick) Descriptor
deprecated
func (*OnClick) GetOpenDynamicLinkAction ¶
func (*OnClick) GetOpenLink ¶
func (*OnClick) ProtoMessage ¶
func (*OnClick) ProtoMessage()
func (*OnClick) ProtoReflect ¶
func (x *OnClick) ProtoReflect() protoreflect.Message
type OnClick_Action ¶
type OnClick_Action struct { // If specified, an action is triggered by this `onClick`. Action *Action `protobuf:"bytes,1,opt,name=action,proto3,oneof"` }
type OnClick_Card ¶
type OnClick_Card struct { // A new card is pushed to the card stack after clicking if specified. // // [Google Workspace // Add-ons](https://developers.google.com/workspace/add-ons): Card *Card `protobuf:"bytes,4,opt,name=card,proto3,oneof"` }
type OnClick_OpenDynamicLinkAction ¶
type OnClick_OpenDynamicLinkAction struct { // An add-on triggers this action when the action needs to open a // link. This differs from the `open_link` above in that this needs to talk // to server to get the link. Thus some preparation work is required for // web client to do before the open link action response comes back. // // [Google Workspace // Add-ons](https://developers.google.com/workspace/add-ons): OpenDynamicLinkAction *Action `protobuf:"bytes,3,opt,name=open_dynamic_link_action,json=openDynamicLinkAction,proto3,oneof"` }
type OnClick_OpenLink ¶
type OnClick_OpenLink struct { // If specified, this `onClick` triggers an open link action. OpenLink *OpenLink `protobuf:"bytes,2,opt,name=open_link,json=openLink,proto3,oneof"` }
type OpenLink ¶
type OpenLink struct { // The URL to open. Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"` // How to open a link. // // [Google Workspace // Add-ons](https://developers.google.com/workspace/add-ons): OpenAs OpenLink_OpenAs `protobuf:"varint,2,opt,name=open_as,json=openAs,proto3,enum=google.apps.card.v1.OpenLink_OpenAs" json:"open_as,omitempty"` // Whether the client forgets about a link after opening it, or observes it // until the window closes. // // [Google Workspace // Add-ons](https://developers.google.com/workspace/add-ons): OnClose OpenLink_OnClose `protobuf:"varint,3,opt,name=on_close,json=onClose,proto3,enum=google.apps.card.v1.OpenLink_OnClose" json:"on_close,omitempty"` // contains filtered or unexported fields }
Represents an `onClick` event that opens a hyperlink.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
func (*OpenLink) Descriptor
deprecated
func (*OpenLink) GetOnClose ¶
func (x *OpenLink) GetOnClose() OpenLink_OnClose
func (*OpenLink) GetOpenAs ¶
func (x *OpenLink) GetOpenAs() OpenLink_OpenAs
func (*OpenLink) ProtoMessage ¶
func (*OpenLink) ProtoMessage()
func (*OpenLink) ProtoReflect ¶
func (x *OpenLink) ProtoReflect() protoreflect.Message
type OpenLink_OnClose ¶
type OpenLink_OnClose int32
What the client does when a link opened by an `OnClick` action is closed.
Implementation depends on client platform capabilities. For example, a web browser might open a link in a pop-up window with an `OnClose` handler.
If both `OnOpen` and `OnClose` handlers are set, and the client platform can't support both values, `OnClose` takes precedence.
[Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):
const ( // Default value. The card doesn't reload; nothing happens. OpenLink_NOTHING OpenLink_OnClose = 0 // Reloads the card after the child window closes. // // If used in conjunction with // [`OpenAs.OVERLAY`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#openas), // the child window acts as a modal dialog and the parent card is blocked // until the child window closes. OpenLink_RELOAD OpenLink_OnClose = 1 )
func (OpenLink_OnClose) Descriptor ¶
func (OpenLink_OnClose) Descriptor() protoreflect.EnumDescriptor
func (OpenLink_OnClose) Enum ¶
func (x OpenLink_OnClose) Enum() *OpenLink_OnClose
func (OpenLink_OnClose) EnumDescriptor
deprecated
func (OpenLink_OnClose) EnumDescriptor() ([]byte, []int)
Deprecated: Use OpenLink_OnClose.Descriptor instead.
func (OpenLink_OnClose) Number ¶
func (x OpenLink_OnClose) Number() protoreflect.EnumNumber
func (OpenLink_OnClose) String ¶
func (x OpenLink_OnClose) String() string
func (OpenLink_OnClose) Type ¶
func (OpenLink_OnClose) Type() protoreflect.EnumType
type OpenLink_OpenAs ¶
type OpenLink_OpenAs int32
When an `OnClick` action opens a link, then the client can either open it as a full-size window (if that's the frame used by the client), or an overlay (such as a pop-up). The implementation depends on the client platform capabilities, and the value selected might be ignored if the client doesn't support it. `FULL_SIZE` is supported by all clients.
[Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):
const ( // The link opens as a full-size window (if that's the frame used by the // client). OpenLink_FULL_SIZE OpenLink_OpenAs = 0 // The link opens as an overlay, such as a pop-up. OpenLink_OVERLAY OpenLink_OpenAs = 1 )
func (OpenLink_OpenAs) Descriptor ¶
func (OpenLink_OpenAs) Descriptor() protoreflect.EnumDescriptor
func (OpenLink_OpenAs) Enum ¶
func (x OpenLink_OpenAs) Enum() *OpenLink_OpenAs
func (OpenLink_OpenAs) EnumDescriptor
deprecated
func (OpenLink_OpenAs) EnumDescriptor() ([]byte, []int)
Deprecated: Use OpenLink_OpenAs.Descriptor instead.
func (OpenLink_OpenAs) Number ¶
func (x OpenLink_OpenAs) Number() protoreflect.EnumNumber
func (OpenLink_OpenAs) String ¶
func (x OpenLink_OpenAs) String() string
func (OpenLink_OpenAs) Type ¶
func (OpenLink_OpenAs) Type() protoreflect.EnumType
type SelectionInput ¶
type SelectionInput struct { // The name that identifies the selection input in a form input event. // // For details about working with form inputs, see [Receive form // data](https://developers.google.com/workspace/chat/read-form-data). Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // The text that appears above the selection input field in the user // interface. // // Specify text that helps the user enter the information your app needs. // For example, if users are selecting the urgency of a work ticket from a // drop-down menu, the label might be "Urgency" or "Select urgency". Label string `protobuf:"bytes,2,opt,name=label,proto3" json:"label,omitempty"` // The type of items that are displayed to users in a `SelectionInput` widget. // Selection types support different types of interactions. For example, users // can select one or more checkboxes, but they can only select one value from // a dropdown menu. Type SelectionInput_SelectionType `protobuf:"varint,3,opt,name=type,proto3,enum=google.apps.card.v1.SelectionInput_SelectionType" json:"type,omitempty"` // An array of selectable items. For example, an array of radio buttons or // checkboxes. Supports up to 100 items. Items []*SelectionInput_SelectionItem `protobuf:"bytes,4,rep,name=items,proto3" json:"items,omitempty"` // If specified, the form is submitted when the selection changes. If not // specified, you must specify a separate button that submits the form. // // For details about working with form inputs, see [Receive form // data](https://developers.google.com/workspace/chat/read-form-data). OnChangeAction *Action `protobuf:"bytes,5,opt,name=on_change_action,json=onChangeAction,proto3" json:"on_change_action,omitempty"` // For multiselect menus, the maximum number of items that a user can select. // Minimum value is 1 item. If unspecified, defaults to 3 items. MultiSelectMaxSelectedItems int32 `` /* 149-byte string literal not displayed */ // For multiselect menus, the number of text characters that a user inputs // before the app queries autocomplete and displays suggested items // in the menu. // // If unspecified, defaults to 0 characters for static data sources and 3 // characters for external data sources. MultiSelectMinQueryLength int32 `` /* 143-byte string literal not displayed */ // For a multiselect menu, the data source that populates // selection items. // // [Google Chat apps](https://developers.google.com/workspace/chat): // // Types that are assignable to MultiSelectDataSource: // // *SelectionInput_ExternalDataSource // *SelectionInput_PlatformDataSource_ MultiSelectDataSource isSelectionInput_MultiSelectDataSource `protobuf_oneof:"multi_select_data_source"` // contains filtered or unexported fields }
A widget that creates one or more UI items that users can select. For example, a dropdown menu or checkboxes. You can use this widget to collect data that can be predicted or enumerated. For an example in Google Chat apps, see [Add selectable UI elements](/workspace/chat/design-interactive-card-dialog#add_selectable_ui_elements).
Chat apps can process the value of items that users select or input. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
To collect undefined or abstract data from users, use the TextInput[google.apps.card.v1.TextInput] widget.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
func (*SelectionInput) Descriptor
deprecated
func (*SelectionInput) Descriptor() ([]byte, []int)
Deprecated: Use SelectionInput.ProtoReflect.Descriptor instead.
func (*SelectionInput) GetExternalDataSource ¶
func (x *SelectionInput) GetExternalDataSource() *Action
func (*SelectionInput) GetItems ¶
func (x *SelectionInput) GetItems() []*SelectionInput_SelectionItem
func (*SelectionInput) GetLabel ¶
func (x *SelectionInput) GetLabel() string
func (*SelectionInput) GetMultiSelectDataSource ¶
func (m *SelectionInput) GetMultiSelectDataSource() isSelectionInput_MultiSelectDataSource
func (*SelectionInput) GetMultiSelectMaxSelectedItems ¶
func (x *SelectionInput) GetMultiSelectMaxSelectedItems() int32
func (*SelectionInput) GetMultiSelectMinQueryLength ¶
func (x *SelectionInput) GetMultiSelectMinQueryLength() int32
func (*SelectionInput) GetName ¶
func (x *SelectionInput) GetName() string
func (*SelectionInput) GetOnChangeAction ¶
func (x *SelectionInput) GetOnChangeAction() *Action
func (*SelectionInput) GetPlatformDataSource ¶
func (x *SelectionInput) GetPlatformDataSource() *SelectionInput_PlatformDataSource
func (*SelectionInput) GetType ¶
func (x *SelectionInput) GetType() SelectionInput_SelectionType
func (*SelectionInput) ProtoMessage ¶
func (*SelectionInput) ProtoMessage()
func (*SelectionInput) ProtoReflect ¶
func (x *SelectionInput) ProtoReflect() protoreflect.Message
func (*SelectionInput) Reset ¶
func (x *SelectionInput) Reset()
func (*SelectionInput) String ¶
func (x *SelectionInput) String() string
type SelectionInput_ExternalDataSource ¶
type SelectionInput_ExternalDataSource struct { // An external data source, such as a relational data base. ExternalDataSource *Action `protobuf:"bytes,8,opt,name=external_data_source,json=externalDataSource,proto3,oneof"` }
type SelectionInput_PlatformDataSource ¶
type SelectionInput_PlatformDataSource struct { // The data source. // // Types that are assignable to DataSource: // // *SelectionInput_PlatformDataSource_CommonDataSource_ DataSource isSelectionInput_PlatformDataSource_DataSource `protobuf_oneof:"data_source"` // contains filtered or unexported fields }
For a [`SelectionInput`][google.apps.card.v1.SelectionInput] widget that uses a multiselect menu, a data source from Google Workspace. Used to populate items in a multiselect menu.
[Google Chat apps](https://developers.google.com/workspace/chat):
func (*SelectionInput_PlatformDataSource) Descriptor
deprecated
func (*SelectionInput_PlatformDataSource) Descriptor() ([]byte, []int)
Deprecated: Use SelectionInput_PlatformDataSource.ProtoReflect.Descriptor instead.
func (*SelectionInput_PlatformDataSource) GetCommonDataSource ¶
func (x *SelectionInput_PlatformDataSource) GetCommonDataSource() SelectionInput_PlatformDataSource_CommonDataSource
func (*SelectionInput_PlatformDataSource) GetDataSource ¶
func (m *SelectionInput_PlatformDataSource) GetDataSource() isSelectionInput_PlatformDataSource_DataSource
func (*SelectionInput_PlatformDataSource) ProtoMessage ¶
func (*SelectionInput_PlatformDataSource) ProtoMessage()
func (*SelectionInput_PlatformDataSource) ProtoReflect ¶
func (x *SelectionInput_PlatformDataSource) ProtoReflect() protoreflect.Message
func (*SelectionInput_PlatformDataSource) Reset ¶
func (x *SelectionInput_PlatformDataSource) Reset()
func (*SelectionInput_PlatformDataSource) String ¶
func (x *SelectionInput_PlatformDataSource) String() string
type SelectionInput_PlatformDataSource_ ¶
type SelectionInput_PlatformDataSource_ struct { // A data source from Google Workspace. PlatformDataSource *SelectionInput_PlatformDataSource `protobuf:"bytes,9,opt,name=platform_data_source,json=platformDataSource,proto3,oneof"` }
type SelectionInput_PlatformDataSource_CommonDataSource ¶
type SelectionInput_PlatformDataSource_CommonDataSource int32
A data source shared by all [Google Workspace applications] (https://developers.google.com/workspace/chat/api/reference/rest/v1/HostApp).
[Google Chat apps](https://developers.google.com/workspace/chat):
const ( // Default value. Don't use. SelectionInput_PlatformDataSource_UNKNOWN SelectionInput_PlatformDataSource_CommonDataSource = 0 // Google Workspace users. The user can only view and select users from // their Google Workspace organization. SelectionInput_PlatformDataSource_USER SelectionInput_PlatformDataSource_CommonDataSource = 1 )
func (SelectionInput_PlatformDataSource_CommonDataSource) Descriptor ¶
func (SelectionInput_PlatformDataSource_CommonDataSource) Descriptor() protoreflect.EnumDescriptor
func (SelectionInput_PlatformDataSource_CommonDataSource) EnumDescriptor
deprecated
func (SelectionInput_PlatformDataSource_CommonDataSource) EnumDescriptor() ([]byte, []int)
Deprecated: Use SelectionInput_PlatformDataSource_CommonDataSource.Descriptor instead.
func (SelectionInput_PlatformDataSource_CommonDataSource) Number ¶
func (x SelectionInput_PlatformDataSource_CommonDataSource) Number() protoreflect.EnumNumber
func (SelectionInput_PlatformDataSource_CommonDataSource) String ¶
func (x SelectionInput_PlatformDataSource_CommonDataSource) String() string
type SelectionInput_PlatformDataSource_CommonDataSource_ ¶
type SelectionInput_PlatformDataSource_CommonDataSource_ struct { // A data source shared by all Google Workspace applications, such as // users in a Google Workspace organization. CommonDataSource SelectionInput_PlatformDataSource_CommonDataSource `` /* 158-byte string literal not displayed */ }
type SelectionInput_SelectionItem ¶
type SelectionInput_SelectionItem struct { // The text that identifies or describes the item to users. Text string `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"` // The value associated with this item. The client should use this as a form // input value. // // For details about working with form inputs, see [Receive form // data](https://developers.google.com/workspace/chat/read-form-data). Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // Whether the item is selected by default. If the selection input only // accepts one value (such as for radio buttons or a dropdown menu), only // set this field for one item. Selected bool `protobuf:"varint,3,opt,name=selected,proto3" json:"selected,omitempty"` // For multiselect menus, the URL for the icon displayed next to // the item's `text` field. Supports PNG and JPEG files. Must be an `HTTPS` // URL. For example, // `https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png`. StartIconUri string `protobuf:"bytes,4,opt,name=start_icon_uri,json=startIconUri,proto3" json:"start_icon_uri,omitempty"` // For multiselect menus, a text description or label that's // displayed below the item's `text` field. BottomText string `protobuf:"bytes,5,opt,name=bottom_text,json=bottomText,proto3" json:"bottom_text,omitempty"` // contains filtered or unexported fields }
An item that users can select in a selection input, such as a checkbox or switch.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
func (*SelectionInput_SelectionItem) Descriptor
deprecated
func (*SelectionInput_SelectionItem) Descriptor() ([]byte, []int)
Deprecated: Use SelectionInput_SelectionItem.ProtoReflect.Descriptor instead.
func (*SelectionInput_SelectionItem) GetBottomText ¶
func (x *SelectionInput_SelectionItem) GetBottomText() string
func (*SelectionInput_SelectionItem) GetSelected ¶
func (x *SelectionInput_SelectionItem) GetSelected() bool
func (*SelectionInput_SelectionItem) GetStartIconUri ¶
func (x *SelectionInput_SelectionItem) GetStartIconUri() string
func (*SelectionInput_SelectionItem) GetText ¶
func (x *SelectionInput_SelectionItem) GetText() string
func (*SelectionInput_SelectionItem) GetValue ¶
func (x *SelectionInput_SelectionItem) GetValue() string
func (*SelectionInput_SelectionItem) ProtoMessage ¶
func (*SelectionInput_SelectionItem) ProtoMessage()
func (*SelectionInput_SelectionItem) ProtoReflect ¶
func (x *SelectionInput_SelectionItem) ProtoReflect() protoreflect.Message
func (*SelectionInput_SelectionItem) Reset ¶
func (x *SelectionInput_SelectionItem) Reset()
func (*SelectionInput_SelectionItem) String ¶
func (x *SelectionInput_SelectionItem) String() string
type SelectionInput_SelectionType ¶
type SelectionInput_SelectionType int32
The format for the items that users can select. Different options support different types of interactions. For example, users can select multiple checkboxes, but can only select one item from a dropdown menu.
Each selection input supports one type of selection. Mixing checkboxes and switches, for example, isn't supported.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
const ( // A set of checkboxes. Users can select one or more checkboxes. SelectionInput_CHECK_BOX SelectionInput_SelectionType = 0 // A set of radio buttons. Users can select one radio button. SelectionInput_RADIO_BUTTON SelectionInput_SelectionType = 1 // A set of switches. Users can turn on one or more switches. SelectionInput_SWITCH SelectionInput_SelectionType = 2 // A dropdown menu. Users can select one item from the menu. SelectionInput_DROPDOWN SelectionInput_SelectionType = 3 // A multiselect menu for static or dynamic data. From the menu bar, // users select one or more items. Users can also input values to populate // dynamic data. For example, users can start typing the name of a Google // Chat space and the widget autosuggests the space. // // To populate items for a multiselect menu, you can use one of the // following types of data sources: // // - Static data: Items are specified as `SelectionItem` objects in the // widget. Up to 100 items. // - Google Workspace data: Items are populated using data from Google // Workspace, such as Google Workspace users or Google Chat spaces. // - External data: Items are populated from an external data // source outside of Google Workspace. // // For examples of how to implement multiselect menus, see // [Add a multiselect // menu](https://developers.google.com/workspace/chat/design-interactive-card-dialog#multiselect-menu). // // [Google Workspace Add-ons and Chat // apps](https://developers.google.com/workspace/extend): // Multiselect for Google Workspace Add-ons are in // Developer Preview. SelectionInput_MULTI_SELECT SelectionInput_SelectionType = 4 )
func (SelectionInput_SelectionType) Descriptor ¶
func (SelectionInput_SelectionType) Descriptor() protoreflect.EnumDescriptor
func (SelectionInput_SelectionType) Enum ¶
func (x SelectionInput_SelectionType) Enum() *SelectionInput_SelectionType
func (SelectionInput_SelectionType) EnumDescriptor
deprecated
func (SelectionInput_SelectionType) EnumDescriptor() ([]byte, []int)
Deprecated: Use SelectionInput_SelectionType.Descriptor instead.
func (SelectionInput_SelectionType) Number ¶
func (x SelectionInput_SelectionType) Number() protoreflect.EnumNumber
func (SelectionInput_SelectionType) String ¶
func (x SelectionInput_SelectionType) String() string
func (SelectionInput_SelectionType) Type ¶
func (SelectionInput_SelectionType) Type() protoreflect.EnumType
type Suggestions ¶
type Suggestions struct { // A list of suggestions used for autocomplete recommendations in text input // fields. Items []*Suggestions_SuggestionItem `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"` // contains filtered or unexported fields }
Suggested values that users can enter. These values appear when users click inside the text input field. As users type, the suggested values dynamically filter to match what the users have typed.
For example, a text input field for programming language might suggest Java, JavaScript, Python, and C++. When users start typing `Jav`, the list of suggestions filters to show `Java` and `JavaScript`.
Suggested values help guide users to enter values that your app can make sense of. When referring to JavaScript, some users might enter `javascript` and others `java script`. Suggesting `JavaScript` can standardize how users interact with your app.
When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
func (*Suggestions) Descriptor
deprecated
func (*Suggestions) Descriptor() ([]byte, []int)
Deprecated: Use Suggestions.ProtoReflect.Descriptor instead.
func (*Suggestions) GetItems ¶
func (x *Suggestions) GetItems() []*Suggestions_SuggestionItem
func (*Suggestions) ProtoMessage ¶
func (*Suggestions) ProtoMessage()
func (*Suggestions) ProtoReflect ¶
func (x *Suggestions) ProtoReflect() protoreflect.Message
func (*Suggestions) Reset ¶
func (x *Suggestions) Reset()
func (*Suggestions) String ¶
func (x *Suggestions) String() string
type Suggestions_SuggestionItem ¶
type Suggestions_SuggestionItem struct { // Types that are assignable to Content: // // *Suggestions_SuggestionItem_Text Content isSuggestions_SuggestionItem_Content `protobuf_oneof:"content"` // contains filtered or unexported fields }
One suggested value that users can enter in a text input field.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
func (*Suggestions_SuggestionItem) Descriptor
deprecated
func (*Suggestions_SuggestionItem) Descriptor() ([]byte, []int)
Deprecated: Use Suggestions_SuggestionItem.ProtoReflect.Descriptor instead.
func (*Suggestions_SuggestionItem) GetContent ¶
func (m *Suggestions_SuggestionItem) GetContent() isSuggestions_SuggestionItem_Content
func (*Suggestions_SuggestionItem) GetText ¶
func (x *Suggestions_SuggestionItem) GetText() string
func (*Suggestions_SuggestionItem) ProtoMessage ¶
func (*Suggestions_SuggestionItem) ProtoMessage()
func (*Suggestions_SuggestionItem) ProtoReflect ¶
func (x *Suggestions_SuggestionItem) ProtoReflect() protoreflect.Message
func (*Suggestions_SuggestionItem) Reset ¶
func (x *Suggestions_SuggestionItem) Reset()
func (*Suggestions_SuggestionItem) String ¶
func (x *Suggestions_SuggestionItem) String() string
type Suggestions_SuggestionItem_Text ¶
type Suggestions_SuggestionItem_Text struct { // The value of a suggested input to a text input field. This is // equivalent to what users enter themselves. Text string `protobuf:"bytes,1,opt,name=text,proto3,oneof"` }
type TextInput ¶
type TextInput struct { // The name by which the text input is identified in a form input event. // // For details about working with form inputs, see [Receive form // data](https://developers.google.com/workspace/chat/read-form-data). Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // The text that appears above the text input field in the user interface. // // Specify text that helps the user enter the information your app needs. // For example, if you are asking someone's name, but specifically need their // surname, write `surname` instead of `name`. // // Required if `hintText` is unspecified. Otherwise, optional. Label string `protobuf:"bytes,2,opt,name=label,proto3" json:"label,omitempty"` // Text that appears below the text input field meant to assist users by // prompting them to enter a certain value. This text is always visible. // // Required if `label` is unspecified. Otherwise, optional. HintText string `protobuf:"bytes,3,opt,name=hint_text,json=hintText,proto3" json:"hint_text,omitempty"` // The value entered by a user, returned as part of a form input event. // // For details about working with form inputs, see [Receive form // data](https://developers.google.com/workspace/chat/read-form-data). Value string `protobuf:"bytes,4,opt,name=value,proto3" json:"value,omitempty"` // How a text input field appears in the user interface. // For example, whether the field is single or multi-line. Type TextInput_Type `protobuf:"varint,5,opt,name=type,proto3,enum=google.apps.card.v1.TextInput_Type" json:"type,omitempty"` // What to do when a change occurs in the text input field. For example, a // user adding to the field or deleting text. // // Examples of actions to take include running a custom function or opening // a [dialog](https://developers.google.com/workspace/chat/dialogs) // in Google Chat. OnChangeAction *Action `protobuf:"bytes,6,opt,name=on_change_action,json=onChangeAction,proto3" json:"on_change_action,omitempty"` // Suggested values that users can enter. These values appear when users click // inside the text input field. As users type, the suggested values // dynamically filter to match what the users have typed. // // For example, a text input field for programming language might suggest // Java, JavaScript, Python, and C++. When users start typing `Jav`, the list // of suggestions filters to show just `Java` and `JavaScript`. // // Suggested values help guide users to enter values that your app can make // sense of. When referring to JavaScript, some users might enter `javascript` // and others `java script`. Suggesting `JavaScript` can standardize how users // interact with your app. // // When specified, `TextInput.type` is always `SINGLE_LINE`, even if it's set // to `MULTIPLE_LINE`. // // [Google Workspace // Add-ons and Chat apps](https://developers.google.com/workspace/extend): InitialSuggestions *Suggestions `protobuf:"bytes,7,opt,name=initial_suggestions,json=initialSuggestions,proto3" json:"initial_suggestions,omitempty"` // Optional. Specify what action to take when the text input field provides // suggestions to users who interact with it. // // If unspecified, the suggestions are set by `initialSuggestions` and // are processed by the client. // // If specified, the app takes the action specified here, such as running // a custom function. // // [Google Workspace // Add-ons](https://developers.google.com/workspace/add-ons): AutoCompleteAction *Action `protobuf:"bytes,8,opt,name=auto_complete_action,json=autoCompleteAction,proto3" json:"auto_complete_action,omitempty"` // Text that appears in the text input field when the field is empty. // Use this text to prompt users to enter a value. For example, `Enter a // number from 0 to 100`. // // [Google Chat apps](https://developers.google.com/workspace/chat): PlaceholderText string `protobuf:"bytes,12,opt,name=placeholder_text,json=placeholderText,proto3" json:"placeholder_text,omitempty"` // contains filtered or unexported fields }
A field in which users can enter text. Supports suggestions and on-change actions. For an example in Google Chat apps, see [Add a field in which a user can enter text](https://developers.google.com/workspace/chat/design-interactive-card-dialog#add_a_field_in_which_a_user_can_enter_text).
Chat apps receive and can process the value of entered text during form input events. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).
When you need to collect undefined or abstract data from users, use a text input. To collect defined or enumerated data from users, use the SelectionInput[google.apps.card.v1.SelectionInput] widget.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
func (*TextInput) Descriptor
deprecated
func (*TextInput) GetAutoCompleteAction ¶
func (*TextInput) GetHintText ¶
func (*TextInput) GetInitialSuggestions ¶
func (x *TextInput) GetInitialSuggestions() *Suggestions
func (*TextInput) GetOnChangeAction ¶
func (*TextInput) GetPlaceholderText ¶
func (*TextInput) GetType ¶
func (x *TextInput) GetType() TextInput_Type
func (*TextInput) ProtoMessage ¶
func (*TextInput) ProtoMessage()
func (*TextInput) ProtoReflect ¶
func (x *TextInput) ProtoReflect() protoreflect.Message
type TextInput_Type ¶
type TextInput_Type int32
How a text input field appears in the user interface. For example, whether it's a single line input field, or a multi-line input. If `initialSuggestions` is specified, `type` is always `SINGLE_LINE`, even if it's set to `MULTIPLE_LINE`.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
const ( // The text input field has a fixed height of one line. TextInput_SINGLE_LINE TextInput_Type = 0 // The text input field has a fixed height of multiple lines. TextInput_MULTIPLE_LINE TextInput_Type = 1 )
func (TextInput_Type) Descriptor ¶
func (TextInput_Type) Descriptor() protoreflect.EnumDescriptor
func (TextInput_Type) Enum ¶
func (x TextInput_Type) Enum() *TextInput_Type
func (TextInput_Type) EnumDescriptor
deprecated
func (TextInput_Type) EnumDescriptor() ([]byte, []int)
Deprecated: Use TextInput_Type.Descriptor instead.
func (TextInput_Type) Number ¶
func (x TextInput_Type) Number() protoreflect.EnumNumber
func (TextInput_Type) String ¶
func (x TextInput_Type) String() string
func (TextInput_Type) Type ¶
func (TextInput_Type) Type() protoreflect.EnumType
type TextParagraph ¶
type TextParagraph struct { // The text that's shown in the widget. Text string `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"` // contains filtered or unexported fields }
A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
func (*TextParagraph) Descriptor
deprecated
func (*TextParagraph) Descriptor() ([]byte, []int)
Deprecated: Use TextParagraph.ProtoReflect.Descriptor instead.
func (*TextParagraph) GetText ¶
func (x *TextParagraph) GetText() string
func (*TextParagraph) ProtoMessage ¶
func (*TextParagraph) ProtoMessage()
func (*TextParagraph) ProtoReflect ¶
func (x *TextParagraph) ProtoReflect() protoreflect.Message
func (*TextParagraph) Reset ¶
func (x *TextParagraph) Reset()
func (*TextParagraph) String ¶
func (x *TextParagraph) String() string
type Widget ¶
type Widget struct { // A widget can only have one of the following items. You can use multiple // widget fields to display more items. // // Types that are assignable to Data: // // *Widget_TextParagraph // *Widget_Image // *Widget_DecoratedText // *Widget_ButtonList // *Widget_TextInput // *Widget_SelectionInput // *Widget_DateTimePicker // *Widget_Divider // *Widget_Grid // *Widget_Columns Data isWidget_Data `protobuf_oneof:"data"` // Specifies whether widgets align to the left, right, or center of a column. HorizontalAlignment Widget_HorizontalAlignment `` /* 171-byte string literal not displayed */ // contains filtered or unexported fields }
Each card is made up of widgets.
A widget is a composite object that can represent one of text, images, buttons, and other object types.
func (*Widget) Descriptor
deprecated
func (*Widget) GetButtonList ¶
func (x *Widget) GetButtonList() *ButtonList
func (*Widget) GetColumns ¶
func (*Widget) GetDateTimePicker ¶
func (x *Widget) GetDateTimePicker() *DateTimePicker
func (*Widget) GetDecoratedText ¶
func (x *Widget) GetDecoratedText() *DecoratedText
func (*Widget) GetDivider ¶
func (*Widget) GetHorizontalAlignment ¶
func (x *Widget) GetHorizontalAlignment() Widget_HorizontalAlignment
func (*Widget) GetSelectionInput ¶
func (x *Widget) GetSelectionInput() *SelectionInput
func (*Widget) GetTextInput ¶
func (*Widget) GetTextParagraph ¶
func (x *Widget) GetTextParagraph() *TextParagraph
func (*Widget) ProtoMessage ¶
func (*Widget) ProtoMessage()
func (*Widget) ProtoReflect ¶
func (x *Widget) ProtoReflect() protoreflect.Message
type Widget_ButtonList ¶
type Widget_ButtonList struct { // A list of buttons. // // For example, the following JSON creates two buttons. The first // is a blue text button and the second is an image button that opens a // link: // “` // // "buttonList": { // "buttons": [ // { // "text": "Edit", // "color": { // "red": 0, // "green": 0, // "blue": 1, // "alpha": 1 // }, // "disabled": true, // }, // { // "icon": { // "knownIcon": "INVITE", // "altText": "check calendar" // }, // "onClick": { // "openLink": { // "url": "https://example.com/calendar" // } // } // } // ] // } // // “` ButtonList *ButtonList `protobuf:"bytes,4,opt,name=button_list,json=buttonList,proto3,oneof"` }
type Widget_Columns ¶
type Widget_Columns struct { // Displays up to 2 columns. // // To include more than 2 columns, or to use rows, use the `Grid` widget. // // For example, the following JSON creates 2 columns that each contain // text paragraphs: // // “` // // "columns": { // "columnItems": [ // { // "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", // "horizontalAlignment": "CENTER", // "verticalAlignment": "CENTER", // "widgets": [ // { // "textParagraph": { // "text": "First column text paragraph" // } // } // ] // }, // { // "horizontalSizeStyle": "FILL_AVAILABLE_SPACE", // "horizontalAlignment": "CENTER", // "verticalAlignment": "CENTER", // "widgets": [ // { // "textParagraph": { // "text": "Second column text paragraph" // } // } // ] // } // ] // } // // “` Columns *Columns `protobuf:"bytes,11,opt,name=columns,proto3,oneof"` }
type Widget_DateTimePicker ¶
type Widget_DateTimePicker struct { // Displays a widget that lets users input a date, time, or date and time. // // For example, the following JSON creates a date time picker to schedule an // appointment: // // “` // // "dateTimePicker": { // "name": "appointment_time", // "label": "Book your appointment at:", // "type": "DATE_AND_TIME", // "valueMsEpoch": "796435200000" // } // // “` DateTimePicker *DateTimePicker `protobuf:"bytes,7,opt,name=date_time_picker,json=dateTimePicker,proto3,oneof"` }
type Widget_DecoratedText ¶
type Widget_DecoratedText struct { // Displays a decorated text item. // // For example, the following JSON creates a decorated text widget showing // email address: // // “` // // "decoratedText": { // "icon": { // "knownIcon": "EMAIL" // }, // "topLabel": "Email Address", // "text": "sasha@example.com", // "bottomLabel": "This is a new Email address!", // "switchControl": { // "name": "has_send_welcome_email_to_sasha", // "selected": false, // "controlType": "CHECKBOX" // } // } // // “` DecoratedText *DecoratedText `protobuf:"bytes,3,opt,name=decorated_text,json=decoratedText,proto3,oneof"` }
type Widget_Divider ¶
type Widget_Divider struct { // Displays a horizontal line divider between widgets. // // For example, the following JSON creates a divider: // “` // "divider": { // } // “` Divider *Divider `protobuf:"bytes,9,opt,name=divider,proto3,oneof"` }
type Widget_Grid ¶
type Widget_Grid struct { // Displays a grid with a collection of items. // // A grid supports any number of columns and items. The number of rows is // determined by the upper bounds of the number items divided by the number // of columns. A grid with 10 items and 2 columns has 5 rows. A grid with 11 // items and 2 columns has 6 rows. // // [Google Workspace Add-ons and // Chat apps](https://developers.google.com/workspace/extend): // // For example, the following JSON creates a 2 column grid with a single // item: // // “` // // "grid": { // "title": "A fine collection of items", // "columnCount": 2, // "borderStyle": { // "type": "STROKE", // "cornerRadius": 4 // }, // "items": [ // { // "image": { // "imageUri": "https://www.example.com/image.png", // "cropStyle": { // "type": "SQUARE" // }, // "borderStyle": { // "type": "STROKE" // } // }, // "title": "An item", // "textAlignment": "CENTER" // } // ], // "onClick": { // "openLink": { // "url": "https://www.example.com" // } // } // } // // “` Grid *Grid `protobuf:"bytes,10,opt,name=grid,proto3,oneof"` }
type Widget_HorizontalAlignment ¶
type Widget_HorizontalAlignment int32
Specifies whether widgets align to the left, right, or center of a column.
[Google Chat apps](https://developers.google.com/workspace/chat):
const ( // Don't use. Unspecified. Widget_HORIZONTAL_ALIGNMENT_UNSPECIFIED Widget_HorizontalAlignment = 0 // Default value. Aligns widgets to the start position of the column. For // left-to-right layouts, aligns to the left. For right-to-left layouts, // aligns to the right. Widget_START Widget_HorizontalAlignment = 1 // Aligns widgets to the center of the column. Widget_CENTER Widget_HorizontalAlignment = 2 // Aligns widgets to the end position of the column. For left-to-right // layouts, aligns widgets to the right. For right-to-left layouts, aligns // widgets to the left. Widget_END Widget_HorizontalAlignment = 3 )
func (Widget_HorizontalAlignment) Descriptor ¶
func (Widget_HorizontalAlignment) Descriptor() protoreflect.EnumDescriptor
func (Widget_HorizontalAlignment) Enum ¶
func (x Widget_HorizontalAlignment) Enum() *Widget_HorizontalAlignment
func (Widget_HorizontalAlignment) EnumDescriptor
deprecated
func (Widget_HorizontalAlignment) EnumDescriptor() ([]byte, []int)
Deprecated: Use Widget_HorizontalAlignment.Descriptor instead.
func (Widget_HorizontalAlignment) Number ¶
func (x Widget_HorizontalAlignment) Number() protoreflect.EnumNumber
func (Widget_HorizontalAlignment) String ¶
func (x Widget_HorizontalAlignment) String() string
func (Widget_HorizontalAlignment) Type ¶
func (Widget_HorizontalAlignment) Type() protoreflect.EnumType
type Widget_Image ¶
type Widget_Image struct { // Displays an image. // // For example, the following JSON creates an image with alternative text: // “` // // "image": { // "imageUrl": // "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", // "altText": "Chat app avatar" // } // // “` Image *Image `protobuf:"bytes,2,opt,name=image,proto3,oneof"` }
type Widget_ImageType ¶
type Widget_ImageType int32
The shape used to crop the image.
[Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):
const ( // Default value. Applies a square mask to the image. For example, a 4x3 // image becomes 3x3. Widget_SQUARE Widget_ImageType = 0 // Applies a circular mask to the image. For example, a 4x3 image becomes a // circle with a diameter of 3. Widget_CIRCLE Widget_ImageType = 1 )
func (Widget_ImageType) Descriptor ¶
func (Widget_ImageType) Descriptor() protoreflect.EnumDescriptor
func (Widget_ImageType) Enum ¶
func (x Widget_ImageType) Enum() *Widget_ImageType
func (Widget_ImageType) EnumDescriptor
deprecated
func (Widget_ImageType) EnumDescriptor() ([]byte, []int)
Deprecated: Use Widget_ImageType.Descriptor instead.
func (Widget_ImageType) Number ¶
func (x Widget_ImageType) Number() protoreflect.EnumNumber
func (Widget_ImageType) String ¶
func (x Widget_ImageType) String() string
func (Widget_ImageType) Type ¶
func (Widget_ImageType) Type() protoreflect.EnumType
type Widget_SelectionInput ¶
type Widget_SelectionInput struct { // Displays a selection control that lets users select items. Selection // controls can be checkboxes, radio buttons, switches, or dropdown menus. // // For example, the following JSON creates a dropdown menu that lets users // choose a size: // // “` // // "selectionInput": { // "name": "size", // "label": "Size" // "type": "DROPDOWN", // "items": [ // { // "text": "S", // "value": "small", // "selected": false // }, // { // "text": "M", // "value": "medium", // "selected": true // }, // { // "text": "L", // "value": "large", // "selected": false // }, // { // "text": "XL", // "value": "extra_large", // "selected": false // } // ] // } // // “` SelectionInput *SelectionInput `protobuf:"bytes,6,opt,name=selection_input,json=selectionInput,proto3,oneof"` }
type Widget_TextInput ¶
type Widget_TextInput struct { // Displays a text box that users can type into. // // For example, the following JSON creates a text input for an email // address: // // “` // // "textInput": { // "name": "mailing_address", // "label": "Mailing Address" // } // // “` // // As another example, the following JSON creates a text input for a // programming language with static suggestions: // “` // // "textInput": { // "name": "preferred_programing_language", // "label": "Preferred Language", // "initialSuggestions": { // "items": [ // { // "text": "C++" // }, // { // "text": "Java" // }, // { // "text": "JavaScript" // }, // { // "text": "Python" // } // ] // } // } // // “` TextInput *TextInput `protobuf:"bytes,5,opt,name=text_input,json=textInput,proto3,oneof"` }
type Widget_TextParagraph ¶
type Widget_TextParagraph struct { // Displays a text paragraph. Supports simple HTML formatted text. For more // information about formatting text, see // [Formatting text in Google Chat // apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) // and // [Formatting // text in Google Workspace // Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). // // For example, the following JSON creates a bolded text: // “` // // "textParagraph": { // "text": " <b>bold text</b>" // } // // “` TextParagraph *TextParagraph `protobuf:"bytes,1,opt,name=text_paragraph,json=textParagraph,proto3,oneof"` }