View Source GoogleApi.Chat.V1.Model.Annotation (google_api_chat v0.34.3)

Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see Format text 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" } }]

Attributes

  • length (type: integer(), default: nil) - Length of the substring in the plain-text message body this annotation corresponds to.
  • richLinkMetadata (type: GoogleApi.Chat.V1.Model.RichLinkMetadata.t, default: nil) - The metadata for a rich link.
  • slashCommand (type: GoogleApi.Chat.V1.Model.SlashCommandMetadata.t, default: nil) - The metadata for a slash command.
  • startIndex (type: integer(), default: nil) - Start index (0-based, inclusive) in the plain-text message body this annotation corresponds to.
  • type (type: String.t, default: nil) - The type of this annotation.
  • userMention (type: GoogleApi.Chat.V1.Model.UserMentionMetadata.t, default: nil) - The metadata of user mention.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.Chat.V1.Model.Annotation{
  length: integer() | nil,
  richLinkMetadata: GoogleApi.Chat.V1.Model.RichLinkMetadata.t() | nil,
  slashCommand: GoogleApi.Chat.V1.Model.SlashCommandMetadata.t() | nil,
  startIndex: integer() | nil,
  type: String.t() | nil,
  userMention: GoogleApi.Chat.V1.Model.UserMentionMetadata.t() | nil
}

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.