Google Apps Chat V1 Client - Class Image (0.1.4)

Reference documentation and code samples for the Google Apps Chat V1 Client class Image.

An image that's specified by a URL and can have an onclick action.

Generated from protobuf message google.chat.v1.WidgetMarkup.Image

Namespace

Google \ Apps \ Chat \ V1 \ WidgetMarkup

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ image_url string

The URL of the image.
↳ on_click Google\Apps\Chat\V1\WidgetMarkup\OnClick

The onclick action.
↳ aspect_ratio float

The aspect ratio of this image (width and height). This field lets you reserve the right height for the image while waiting for it to load. It's not meant to override the built-in aspect ratio of the image. If unset, the server fills it by prefetching the image.

getImageUrl

The URL of the image.

Returns
Type Description
string

setImageUrl

The URL of the image.

Parameter
Name Description
var string
Returns
Type Description
$this

getOnClick

The onclick action.

Returns
Type Description
Google\Apps\Chat\V1\WidgetMarkup\OnClick|null

hasOnClick

clearOnClick

setOnClick

The onclick action.

Parameter
Name Description
var Google\Apps\Chat\V1\WidgetMarkup\OnClick
Returns
Type Description
$this

getAspectRatio

The aspect ratio of this image (width and height). This field lets you reserve the right height for the image while waiting for it to load.

It's not meant to override the built-in aspect ratio of the image. If unset, the server fills it by prefetching the image.

Returns
Type Description
float

setAspectRatio

The aspect ratio of this image (width and height). This field lets you reserve the right height for the image while waiting for it to load.

It's not meant to override the built-in aspect ratio of the image. If unset, the server fills it by prefetching the image.

Parameter
Name Description
var float
Returns
Type Description
$this