Google is committed to advancing racial equity for Black communities. See how.

Class CardBuilder

CardBuilder

A builder for Card objects.

Methods

MethodReturn typeBrief description
addCardAction(cardAction)CardBuilderAdds a CardAction to this Card.
addSection(section)CardBuilderAdds a section to this card.
build()CardBuilds the current card and validates it.
setDisplayStyle(displayStyle)CardBuilderSets the display style for this card.
setFixedFooter(fixedFooter)CardBuilderSets a fixed footer for this card.
setHeader(cardHeader)CardBuilderSets the header for this card.
setName(name)CardBuilderSets the name for this card.
setPeekCardHeader(peekCardHeader)CardBuilderSets the peek card header.

Detailed documentation

addCardAction(cardAction)

Adds a CardAction to this Card.

Parameters

NameTypeDescription
cardActionCardActionThe CardAction to use.

Return

CardBuilder — This object, for chaining.


addSection(section)

Adds a section to this card. You can't add more than 100 sections to a card.

Parameters

NameTypeDescription
sectionCardSectionThe CardSection to use.

Return

CardBuilder — This object, for chaining.


build()

Builds the current card and validates it.

Return

Card — A validated card.

Throws

Error — if the constructed card isn't valid.


setDisplayStyle(displayStyle)

Sets the display style for this card.

If the display style is set to DisplayStyle.REPLACE, the card is shown by replacing the view of top card in the card stack.

If the display style is set to DisplayStyle.PEEK, 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.

DisplayStyle only works for card returned from contextual trigger function.

Parameters

NameTypeDescription
displayStyleDisplayStyleThe DisplayStyle to set.

Return

CardBuilder — This object, for chaining.


setFixedFooter(fixedFooter)

Sets a fixed footer for this card.

Parameters

NameTypeDescription
fixedFooterFixedFooterThe FixedFooter to use.

Return

CardBuilder — This object, for chaining.


setHeader(cardHeader)

Sets the header for this card.

Parameters

NameTypeDescription
cardHeaderCardHeaderThe CardHeader to use.

Return

CardBuilder — This object, for chaining.


setName(name)

Sets the name for this card. The name can be used for navigation.

Parameters

NameTypeDescription
nameStringThe name.

Return

CardBuilder — This object, for chaining.


setPeekCardHeader(peekCardHeader)

Sets the peek card header.

The peek card is set on the first card returned from a contextual trigger function. It is used as a descriptive placeholder widget so that users can navigate from a homepage stack to the contextual stack.

Parameters

NameTypeDescription
peekCardHeaderCardHeaderThe CardHeader to set.

Return

CardBuilder — This object, for chaining.