Class LinkPreview

LinkPreview

Card action that displays a link preview card and smart chip in the host app. For more information, refer to Preview links with smart chips .

 const 
  
 decoratedText 
  
 = 
  
 CardService 
 . 
 newDecoratedText 
 () 
  
 . 
 setTopLabel 
 ( 
 'Hello' 
 ) 
  
 . 
 setText 
 ( 
 'Hi!' 
 ); 
 const 
  
 cardSection 
  
 = 
  
 CardService 
 . 
 newCardSection 
 () 
  
 . 
 addWidget 
 ( 
 decoratedText 
 ); 
 const 
  
 card 
  
 = 
  
 CardService 
 . 
 newCardBuilder 
 () 
  
 . 
 addSection 
 ( 
 cardSection 
 ) 
  
 . 
 build 
 (); 
 const 
  
 linkPreview 
  
 = 
  
 CardService 
 . 
 newLinkPreview 
 () 
  
 . 
 setPreviewCard 
 ( 
 card 
 ) 
  
 . 
 setTitle 
 ( 
 'Smart chip title' 
 );

Methods

Method	Return type	Brief description
`printJson()`	`String`	Prints the JSON representation of this object.
`setLinkPreviewTitle(title)`	`LinkPreview`	Sets the title that displays in the link preview above the preview card.
`setPreviewCard(previewCard)`	`LinkPreview`	Sets the card that displays information about a link from a third-party or non-Google service.
`setTitle(title)`	`LinkPreview`	Sets the title that displays in the smart chip for the link preview.

Detailed documentation

`printJson()`

Prints the JSON representation of this object. This is for debugging only.

Return

String

`setLinkPreviewTitle(title)`

Sets the title that displays in the link preview above the preview card. If unset, the link preview displays the header of the PreviewCard .

 const 
  
 linkPreview 
  
 = 
  
 CardService 
 . 
 newLinkPreview 
 () 
  
 . 
 setLinkPreviewTitle 
 ( 
 "Link preview title" 
 );

Parameters

Name	Type	Description
`title`	`String`	The title of the link preview.

Return

LinkPreview — This object, for chaining.

`setPreviewCard(previewCard)`

Sets the card that displays information about a link from a third-party or non-Google service.

 const 
  
 decoratedText 
  
 = 
  
 CardService 
 . 
 newDecoratedText 
 () 
  
 . 
 setTopLabel 
 ( 
 'Hello' 
 ) 
  
 . 
 setText 
 ( 
 'Hi!' 
 ); 
 const 
  
 cardSection 
  
 = 
  
 CardService 
 . 
 newCardSection 
 () 
  
 . 
 addWidget 
 ( 
 decoratedText 
 ); 
 const 
  
 card 
  
 = 
  
 CardService 
 . 
 newCardBuilder 
 () 
  
 . 
 addSection 
 ( 
 cardSection 
 ) 
  
 . 
 build 
 (); 
 const 
  
 linkPreview 
  
 = 
  
 CardService 
 . 
 newLinkPreview 
 () 
  
 . 
 setPreviewCard 
 ( 
 card 
 ) 
  
 . 
 setTitle 
 ( 
 'Smart chip title' 
 );

Parameters

Name	Type	Description
`previewCard`	`Card`	The preview card.

Return

LinkPreview — This object, for chaining.

`setTitle(title)`

Sets the title that displays in the smart chip for the link preview. If unset, the smart chip displays the header of the PreviewCard .

 const 
  
 linkPreview 
  
 = 
  
 CardService 
 . 
 newLinkPreview 
 () 
  
 . 
 setTitle 
 ( 
 'Smart chip title' 
 );

Parameters

Name	Type	Description
`title`	`String`	The title of the smart chip.

Return

LinkPreview — This object, for chaining.