Class: Google::Apis::ChatV1::Annotation

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/chat_v1/classes.rb,
lib/google/apis/chat_v1/representations.rb,
lib/google/apis/chat_v1/representations.rb

Overview

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" ` `]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Annotation

Returns a new instance of Annotation.



187
188
189
 
# File 'lib/google/apis/chat_v1/classes.rb', line 187

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#length ⇒ Fixnum

Length of the substring in the plain-text message body this annotation corresponds to. Corresponds to the JSON property length

Returns:

  • (Fixnum) 


159
160
161
 
# File 'lib/google/apis/chat_v1/classes.rb', line 159

def length
  @length
end

#rich_link_metadata ⇒ Google::Apis::ChatV1::RichLinkMetadata

A rich link to a resource. Corresponds to the JSON property richLinkMetadata

Returns:



164
165
166
 
# File 'lib/google/apis/chat_v1/classes.rb', line 164

def rich_link_metadata
  @rich_link_metadata
end

#slash_command ⇒ Google::Apis::ChatV1::SlashCommandMetadata

Annotation metadata for slash commands (/). Corresponds to the JSON property slashCommand

Returns:



169
170
171
 
# File 'lib/google/apis/chat_v1/classes.rb', line 169

def slash_command
  @slash_command
end

#start_index ⇒ Fixnum

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

Returns:

  • (Fixnum) 


175
176
177
 
# File 'lib/google/apis/chat_v1/classes.rb', line 175

def start_index
  @start_index
end

#type ⇒ String

The type of this annotation. Corresponds to the JSON property type

Returns:

  • (String) 


180
181
182
 
# File 'lib/google/apis/chat_v1/classes.rb', line 180

def type
  @type
end

#user_mention ⇒ Google::Apis::ChatV1::UserMentionMetadata

Annotation metadata for user mentions (@). Corresponds to the JSON property userMention

Returns:



185
186
187
 
# File 'lib/google/apis/chat_v1/classes.rb', line 185

def user_mention
  @user_mention
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



192
193
194
195
196
197
198
199
 
# File 'lib/google/apis/chat_v1/classes.rb', line 192

def update!(**args)
  @length = args[:length] if args.key?(:length)
  @rich_link_metadata = args[:rich_link_metadata] if args.key?(:rich_link_metadata)
  @slash_command = args[:slash_command] if args.key?(:slash_command)
  @start_index = args[:start_index] if args.key?(:start_index)
  @type = args[:type] if args.key?(:type)
  @user_mention = args[:user_mention] if args.key?(:user_mention)
end