Google Apps Chat V1 Client - Class ImageButton (0.3.0)

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

An image button with an onclick action.

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

Namespace

Google \ Apps \ Chat \ V1 \ WidgetMarkup

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ icon int

The icon specified by an enum that indices to an icon provided by Chat API.

↳ icon_url string

The icon specified by a URL.

↳ on_click Google\Apps\Chat\V1\WidgetMarkup\OnClick

The onclick action.

↳ name string

The name of this image_button that's used for accessibility. Default value is provided if this name isn't specified.

getIcon

The icon specified by an enum that indices to an icon provided by Chat API.

Returns
Type Description
int

hasIcon

setIcon

The icon specified by an enum that indices to an icon provided by Chat API.

Parameter
Name Description
var int
Returns
Type Description
$this

getIconUrl

The icon specified by a URL.

Returns
Type Description
string

hasIconUrl

setIconUrl

The icon specified by a URL.

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

getName

The name of this image_button that's used for accessibility.

Default value is provided if this name isn't specified.

Returns
Type Description
string

setName

The name of this image_button that's used for accessibility.

Default value is provided if this name isn't specified.

Parameter
Name Description
var string
Returns
Type Description
$this

getIcons

Returns
Type Description
string