Google Apps Chat V1 Client - Class Snippet (0.31.0)

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

A snippet object representing an excerpt from a larger corpus.

Generated from protobuf message google.chat.v1.CitedSource.Snippet

Namespace

Google \ Apps \ Chat \ V1 \ CitedSource

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ text string

Optional. A short plaintext excerpt directly from the corpus that is rendered in the citation hover card or source preview. When footer sources are automatically populated from inline citations (because Elements.cited_sources is not set), snippets are omitted from the deduplicated footer sources. Does not support markdown format, and must not exceed 1,000 characters.

↳ image_preview Google\Apps\Chat\V1\ElementsImage

Optional. Image preview of the snippet provided as an input when creating the citation.

getText

Optional. A short plaintext excerpt directly from the corpus that is rendered in the citation hover card or source preview. When footer sources are automatically populated from inline citations (because Elements.cited_sources is not set), snippets are omitted from the deduplicated footer sources. Does not support markdown format, and must not exceed 1,000 characters.

Returns
Type Description
string

setText

Optional. A short plaintext excerpt directly from the corpus that is rendered in the citation hover card or source preview. When footer sources are automatically populated from inline citations (because Elements.cited_sources is not set), snippets are omitted from the deduplicated footer sources. Does not support markdown format, and must not exceed 1,000 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getImagePreview

Optional. Image preview of the snippet provided as an input when creating the citation.

Returns
Type Description
Google\Apps\Chat\V1\ElementsImage|null

hasImagePreview

clearImagePreview

setImagePreview

Optional. Image preview of the snippet provided as an input when creating the citation.

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