com.google.apps.card.v1.CardOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-common-protos Show documentation
Show all versions of proto-google-common-protos Show documentation
PROTO library for proto-google-common-protos
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/apps/card/v1/card.proto
// Protobuf Java Version: 3.25.4
package com.google.apps.card.v1;
public interface CardOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.apps.card.v1.Card)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The header of the card. A header usually contains a leading image and a
* title. Headers always appear at the top of a card.
*
*
* .google.apps.card.v1.Card.CardHeader header = 1;
*
* @return Whether the header field is set.
*/
boolean hasHeader();
/**
*
*
*
* The header of the card. A header usually contains a leading image and a
* title. Headers always appear at the top of a card.
*
*
* .google.apps.card.v1.Card.CardHeader header = 1;
*
* @return The header.
*/
com.google.apps.card.v1.Card.CardHeader getHeader();
/**
*
*
*
* The header of the card. A header usually contains a leading image and a
* title. Headers always appear at the top of a card.
*
*
* .google.apps.card.v1.Card.CardHeader header = 1;
*/
com.google.apps.card.v1.Card.CardHeaderOrBuilder getHeaderOrBuilder();
/**
*
*
*
* 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).
*
*
* repeated .google.apps.card.v1.Card.Section sections = 2;
*/
java.util.List getSectionsList();
/**
*
*
*
* 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).
*
*
* repeated .google.apps.card.v1.Card.Section sections = 2;
*/
com.google.apps.card.v1.Card.Section getSections(int index);
/**
*
*
*
* 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).
*
*
* repeated .google.apps.card.v1.Card.Section sections = 2;
*/
int getSectionsCount();
/**
*
*
*
* 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).
*
*
* repeated .google.apps.card.v1.Card.Section sections = 2;
*/
java.util.List
getSectionsOrBuilderList();
/**
*
*
*
* 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).
*
*
* repeated .google.apps.card.v1.Card.Section sections = 2;
*/
com.google.apps.card.v1.Card.SectionOrBuilder getSectionsOrBuilder(int index);
/**
*
*
*
* The divider style between sections.
*
*
* .google.apps.card.v1.Card.DividerStyle section_divider_style = 9;
*
* @return The enum numeric value on the wire for sectionDividerStyle.
*/
int getSectionDividerStyleValue();
/**
*
*
*
* The divider style between sections.
*
*
* .google.apps.card.v1.Card.DividerStyle section_divider_style = 9;
*
* @return The sectionDividerStyle.
*/
com.google.apps.card.v1.Card.DividerStyle getSectionDividerStyle();
/**
*
*
*
* 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"
* }
* }
* }
* ]
* ```
*
*
* repeated .google.apps.card.v1.Card.CardAction card_actions = 3;
*/
java.util.List getCardActionsList();
/**
*
*
*
* 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"
* }
* }
* }
* ]
* ```
*
*
* repeated .google.apps.card.v1.Card.CardAction card_actions = 3;
*/
com.google.apps.card.v1.Card.CardAction getCardActions(int index);
/**
*
*
*
* 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"
* }
* }
* }
* ]
* ```
*
*
* repeated .google.apps.card.v1.Card.CardAction card_actions = 3;
*/
int getCardActionsCount();
/**
*
*
*
* 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"
* }
* }
* }
* ]
* ```
*
*
* repeated .google.apps.card.v1.Card.CardAction card_actions = 3;
*/
java.util.List
getCardActionsOrBuilderList();
/**
*
*
*
* 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"
* }
* }
* }
* ]
* ```
*
*
* repeated .google.apps.card.v1.Card.CardAction card_actions = 3;
*/
com.google.apps.card.v1.Card.CardActionOrBuilder getCardActionsOrBuilder(int index);
/**
*
*
*
* Name of the card. Used as a card identifier in card navigation.
*
* [Google Workspace
* Add-ons](https://developers.google.com/workspace/add-ons):
*
*
* string name = 4;
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Name of the card. Used as a card identifier in card navigation.
*
* [Google Workspace
* Add-ons](https://developers.google.com/workspace/add-ons):
*
*
* string name = 4;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* The fixed footer shown at the bottom of this 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).
*
* [Google Workspace Add-ons and Chat
* apps](https://developers.google.com/workspace/extend):
*
*
* .google.apps.card.v1.Card.CardFixedFooter fixed_footer = 5;
*
* @return Whether the fixedFooter field is set.
*/
boolean hasFixedFooter();
/**
*
*
*
* The fixed footer shown at the bottom of this 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).
*
* [Google Workspace Add-ons and Chat
* apps](https://developers.google.com/workspace/extend):
*
*
* .google.apps.card.v1.Card.CardFixedFooter fixed_footer = 5;
*
* @return The fixedFooter.
*/
com.google.apps.card.v1.Card.CardFixedFooter getFixedFooter();
/**
*
*
*
* The fixed footer shown at the bottom of this 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).
*
* [Google Workspace Add-ons and Chat
* apps](https://developers.google.com/workspace/extend):
*
*
* .google.apps.card.v1.Card.CardFixedFooter fixed_footer = 5;
*/
com.google.apps.card.v1.Card.CardFixedFooterOrBuilder getFixedFooterOrBuilder();
/**
*
*
*
* In Google Workspace Add-ons, sets the display properties of the
* `peekCardHeader`.
*
* [Google Workspace
* Add-ons](https://developers.google.com/workspace/add-ons):
*
*
* .google.apps.card.v1.Card.DisplayStyle display_style = 6;
*
* @return The enum numeric value on the wire for displayStyle.
*/
int getDisplayStyleValue();
/**
*
*
*
* In Google Workspace Add-ons, sets the display properties of the
* `peekCardHeader`.
*
* [Google Workspace
* Add-ons](https://developers.google.com/workspace/add-ons):
*
*
* .google.apps.card.v1.Card.DisplayStyle display_style = 6;
*
* @return The displayStyle.
*/
com.google.apps.card.v1.Card.DisplayStyle getDisplayStyle();
/**
*
*
*
* 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):
*
*
* .google.apps.card.v1.Card.CardHeader peek_card_header = 7;
*
* @return Whether the peekCardHeader field is set.
*/
boolean hasPeekCardHeader();
/**
*
*
*
* 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):
*
*
* .google.apps.card.v1.Card.CardHeader peek_card_header = 7;
*
* @return The peekCardHeader.
*/
com.google.apps.card.v1.Card.CardHeader getPeekCardHeader();
/**
*
*
*
* 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):
*
*
* .google.apps.card.v1.Card.CardHeader peek_card_header = 7;
*/
com.google.apps.card.v1.Card.CardHeaderOrBuilder getPeekCardHeaderOrBuilder();
}