Reference documentation and code samples for the Google Apps Chat V1 Client class ImageComponent.
Represents an image.
Google Workspace Add-ons and Chat apps:
Generated from protobuf message google.apps.card.v1.ImageComponent
Namespace
Google \ Apps \ Card \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ image_uri |
string
The image URL. |
↳ alt_text |
string
The accessibility label for the image. |
↳ crop_style |
Google\Apps\Card\V1\ImageCropStyle
The crop style to apply to the image. |
↳ border_style |
Google\Apps\Card\V1\BorderStyle
The border style to apply to the image. |
getImageUri
The image URL.
| Returns | |
|---|---|
| Type | Description |
string |
|
setImageUri
The image URL.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAltText
The accessibility label for the image.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAltText
The accessibility label for the image.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCropStyle
The crop style to apply to the image.
| Returns | |
|---|---|
| Type | Description |
Google\Apps\Card\V1\ImageCropStyle|null |
|
hasCropStyle
clearCropStyle
setCropStyle
The crop style to apply to the image.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Apps\Card\V1\ImageCropStyle
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBorderStyle
The border style to apply to the image.
| Returns | |
|---|---|
| Type | Description |
Google\Apps\Card\V1\BorderStyle|null |
|
hasBorderStyle
clearBorderStyle
setBorderStyle
The border style to apply to the image.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Apps\Card\V1\BorderStyle
|
| Returns | |
|---|---|
| Type | Description |
$this |
|