Google Cloud Discovery Engine V1 Client - Class Shortcut (1.17.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class Shortcut.

Describes an entity of shortcut (aka pinned content) on the homepage.

The home page will render these shortcuts in the same order as what the API returns. If a customer wants to reorder or remove a shortcut, the UI should always provide the new full list of shortcuts.

Generated from protobuf message google.cloud.discoveryengine.v1.WidgetConfig.HomepageSetting.Shortcut

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ WidgetConfig \ HomepageSetting

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ title string

Optional. Title of the shortcut.

↳ icon Google\Cloud\DiscoveryEngine\V1\WidgetConfig\Image

Optional. Icon URL of shortcut.

↳ destination_uri string

Optional. Destination URL of shortcut.

getTitle

Optional. Title of the shortcut.

Returns
Type Description
string

setTitle

Optional. Title of the shortcut.

Parameter
Name Description
var string
Returns
Type Description
$this

getIcon

Optional. Icon URL of shortcut.

Returns
Type Description
Google\Cloud\DiscoveryEngine\V1\WidgetConfig\Image|null

hasIcon

clearIcon

setIcon

Optional. Icon URL of shortcut.

Parameter
Name Description
var Google\Cloud\DiscoveryEngine\V1\WidgetConfig\Image
Returns
Type Description
$this

getDestinationUri

Optional. Destination URL of shortcut.

Returns
Type Description
string

setDestinationUri

Optional. Destination URL of shortcut.

Parameter
Name Description
var string
Returns
Type Description
$this