Google Apps Chat V1 Client - Class CardHeader (0.3.0)

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

Represents a card header. For an example in Google Chat apps, see Add a header.

Google Workspace Add-ons and Chat apps:

Generated from protobuf message google.apps.card.v1.Card.CardHeader

Namespace

Google \ Apps \ Card \ V1 \ Card

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ title string

Required. The title of the card header. The header has a fixed height: if both a title and subtitle are specified, each takes up one line. If only the title is specified, it takes up both lines.

↳ subtitle string

The subtitle of the card header. If specified, appears on its own line below the title.

↳ image_type int

The shape used to crop the image. Google Workspace Add-ons and Chat apps:

↳ image_url string

The HTTPS URL of the image in the card header.

↳ image_alt_text string

The alternative text of this image that's used for accessibility.

getTitle

Required. The title of the card header.

The header has a fixed height: if both a title and subtitle are specified, each takes up one line. If only the title is specified, it takes up both lines.

Returns
Type Description
string

setTitle

Required. The title of the card header.

The header has a fixed height: if both a title and subtitle are specified, each takes up one line. If only the title is specified, it takes up both lines.

Parameter
Name Description
var string
Returns
Type Description
$this

getSubtitle

The subtitle of the card header. If specified, appears on its own line below the title.

Returns
Type Description
string

setSubtitle

The subtitle of the card header. If specified, appears on its own line below the title.

Parameter
Name Description
var string
Returns
Type Description
$this

getImageType

The shape used to crop the image.

Google Workspace Add-ons and Chat apps:

Returns
Type Description
int

setImageType

The shape used to crop the image.

Google Workspace Add-ons and Chat apps:

Parameter
Name Description
var int
Returns
Type Description
$this

getImageUrl

The HTTPS URL of the image in the card header.

Returns
Type Description
string

setImageUrl

The HTTPS URL of the image in the card header.

Parameter
Name Description
var string
Returns
Type Description
$this

getImageAltText

The alternative text of this image that's used for accessibility.

Returns
Type Description
string

setImageAltText

The alternative text of this image that's used for accessibility.

Parameter
Name Description
var string
Returns
Type Description
$this