Reference documentation and code samples for the Google Apps Chat V1 Client class GridItem.
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:
Generated from protobuf message google.apps.card.v1.Grid.GridItem
Namespace
Google \ Apps \ Card \ V1 \ GridMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ id |
string
A user-specified identifier for this grid item. This identifier is returned in the parent grid's |
↳ image |
Google\Apps\Card\V1\ImageComponent
The image that displays in the grid item. |
↳ title |
string
The grid item's title. |
↳ subtitle |
string
The grid item's subtitle. |
↳ layout |
int
The layout to use for the grid item. |
getId
A user-specified identifier for this grid item. This identifier is
returned in the parent grid's onClick callback parameters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setId
A user-specified identifier for this grid item. This identifier is
returned in the parent grid's onClick callback parameters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getImage
The image that displays in the grid item.
| Returns | |
|---|---|
| Type | Description |
Google\Apps\Card\V1\ImageComponent|null |
|
hasImage
clearImage
setImage
The image that displays in the grid item.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Apps\Card\V1\ImageComponent
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTitle
The grid item's title.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTitle
The grid item's title.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSubtitle
The grid item's subtitle.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSubtitle
The grid item's subtitle.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLayout
The layout to use for the grid item.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type GridItemLayout. |
setLayout
The layout to use for the grid item.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type GridItemLayout. |
| Returns | |
|---|---|
| Type | Description |
$this |
|