A builder for Card objects.
Methods
| Method | Return type | Brief description |
|---|---|---|
addCardAction(cardAction) | CardBuilder | Adds a CardAction to this Card. |
addSection(section) | CardBuilder | Adds a section to this card. |
build() | Card | Builds the current card and validates it. |
setDisplayStyle(displayStyle) | CardBuilder | Sets the display style for this card. |
setFixedFooter(fixedFooter) | CardBuilder | Sets a fixed footer for this card. |
setHeader(cardHeader) | CardBuilder | Sets the header for this card. |
setName(name) | CardBuilder | Sets the name for this card. |
setPeekCardHeader(peekCardHeader) | CardBuilder | Sets the peek card header. |
Detailed documentation
addCardAction(cardAction)
Adds a CardAction to this Card.
Parameters
| Name | Type | Description |
|---|---|---|
cardAction | CardAction | The 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
| Name | Type | Description |
|---|---|---|
section | CardSection | The CardSection to use. |
Return
CardBuilder — This object, for chaining.
build()
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
| Name | Type | Description |
|---|---|---|
displayStyle | DisplayStyle | The DisplayStyle to set. |
Return
CardBuilder — This object, for chaining.
setHeader(cardHeader)
Sets the header for this card.
Parameters
| Name | Type | Description |
|---|---|---|
cardHeader | CardHeader | The 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
| Name | Type | Description |
|---|---|---|
name | String | The 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
| Name | Type | Description |
|---|---|---|
peekCardHeader | CardHeader | The CardHeader to set. |
Return
CardBuilder — This object, for chaining.