com.google.api.services.chat.v1.model

Class Annotation

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.chat.v1.model.Annotation

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Annotation
extends com.google.api.client.json.GenericJson

Output only. Annotations can be associated with the plain-text body of the message or with chips that link to Google Workspace resources like Google Docs or Sheets with `start_index` and `length` of 0. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/workspace/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" }, "type":"MENTION" } }] ```

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Chat API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Annotation()

Method Summary

Modifier and Type	Method and Description
Annotation	clone()
CustomEmojiMetadata	getCustomEmojiMetadata() The metadata for a custom emoji.
Integer	getLength() Length of the substring in the plain-text message body this annotation corresponds to.
RichLinkMetadata	getRichLinkMetadata() The metadata for a rich link.
SlashCommandMetadata	getSlashCommand() The metadata for a slash command.
Integer	getStartIndex() Start index (0-based, inclusive) in the plain-text message body this annotation corresponds to.
String	getType() The type of this annotation.
UserMentionMetadata	getUserMention() The metadata of user mention.
Annotation	set(String fieldName, Object value)
Annotation	setCustomEmojiMetadata(CustomEmojiMetadata customEmojiMetadata) The metadata for a custom emoji.
Annotation	setLength(Integer length) Length of the substring in the plain-text message body this annotation corresponds to.
Annotation	setRichLinkMetadata(RichLinkMetadata richLinkMetadata) The metadata for a rich link.
Annotation	setSlashCommand(SlashCommandMetadata slashCommand) The metadata for a slash command.
Annotation	setStartIndex(Integer startIndex) Start index (0-based, inclusive) in the plain-text message body this annotation corresponds to.
Annotation	setType(String type) The type of this annotation.
Annotation	setUserMention(UserMentionMetadata userMention) The metadata of user mention.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Annotation

public Annotation()

Method Detail

getCustomEmojiMetadata

public CustomEmojiMetadata getCustomEmojiMetadata()

The metadata for a custom emoji.

Returns:

value or null for none

setCustomEmojiMetadata

public Annotation setCustomEmojiMetadata(CustomEmojiMetadata customEmojiMetadata)

The metadata for a custom emoji.

Parameters:

customEmojiMetadata - customEmojiMetadata or null for none

getLength

public Integer getLength()

Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.

Returns:

value or null for none

setLength

public Annotation setLength(Integer length)

Length of the substring in the plain-text message body this annotation corresponds to. If not present, indicates a length of 0.

Parameters:

length - length or null for none

getRichLinkMetadata

public RichLinkMetadata getRichLinkMetadata()

The metadata for a rich link.

Returns:

value or null for none

setRichLinkMetadata

public Annotation setRichLinkMetadata(RichLinkMetadata richLinkMetadata)

The metadata for a rich link.

Parameters:

richLinkMetadata - richLinkMetadata or null for none

getSlashCommand

public SlashCommandMetadata getSlashCommand()

The metadata for a slash command.

Returns:

value or null for none

setSlashCommand

public Annotation setSlashCommand(SlashCommandMetadata slashCommand)

The metadata for a slash command.

Parameters:

slashCommand - slashCommand or null for none

getStartIndex

public Integer getStartIndex()

Start index (0-based, inclusive) in the plain-text message body this annotation corresponds to.

Returns:

value or null for none

setStartIndex

public Annotation setStartIndex(Integer startIndex)

Start index (0-based, inclusive) in the plain-text message body this annotation corresponds to.

Parameters:

startIndex - startIndex or null for none

getType

public String getType()

The type of this annotation.

Returns:

value or null for none

setType

public Annotation setType(String type)

The type of this annotation.

Parameters:

type - type or null for none

getUserMention

public UserMentionMetadata getUserMention()

The metadata of user mention.

Returns:

value or null for none

setUserMention

public Annotation setUserMention(UserMentionMetadata userMention)

The metadata of user mention.

Parameters:

userMention - userMention or null for none

set

public Annotation set(String fieldName,
                      Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Annotation clone()

Overrides:

clone in class com.google.api.client.json.GenericJson