Class: Google::Apis::ChatV1::Message

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

A message in Hangouts Chat.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Message

Returns a new instance of Message.



2277
2278
2279
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2277

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

Instance Attribute Details

#action_response ⇒ Google::Apis::ChatV1::ActionResponse

Parameters that a bot can use to configure how it's response is posted. Corresponds to the JSON property actionResponse

Returns:



2205
2206
2207
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2205

def action_response
  @action_response
end

#annotations ⇒ Array<Google::Apis::ChatV1::Annotation>

Output only. Annotations associated with the text in this message. Corresponds to the JSON property annotations

Returns:



2210
2211
2212
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2210

def annotations
  @annotations
end

#argument_text ⇒ String

Plain-text body of the message with all bot mentions stripped out. Corresponds to the JSON property argumentText

Returns:

  • (String) 


2215
2216
2217
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2215

def argument_text
  @argument_text
end

#attachment ⇒ Array<Google::Apis::ChatV1::Attachment>

User uploaded attachment. Corresponds to the JSON property attachment

Returns:



2220
2221
2222
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2220

def attachment
  @attachment
end

#cards ⇒ Array<Google::Apis::ChatV1::Card>

Rich, formatted and interactive cards that can be used to display UI elements such as: formatted texts, buttons, clickable images. Cards are normally displayed below the plain-text body of the message. Corresponds to the JSON property cards

Returns:



2227
2228
2229
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2227

def cards
  @cards
end

#create_time ⇒ String

Output only. The time at which the message was created in Hangouts Chat server. Corresponds to the JSON property createTime

Returns:

  • (String) 


2232
2233
2234
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2232

def create_time
  @create_time
end

#fallback_text ⇒ String

A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications). Corresponds to the JSON property fallbackText

Returns:

  • (String) 


2238
2239
2240
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2238

def fallback_text
  @fallback_text
end

#name ⇒ String

Corresponds to the JSON property name

Returns:

  • (String) 


2243
2244
2245
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2243

def name
  @name
end

#preview_text ⇒ String

Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips. Corresponds to the JSON property previewText

Returns:

  • (String) 


2250
2251
2252
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2250

def preview_text
  @preview_text
end

#sender ⇒ Google::Apis::ChatV1::User

A user in Google Chat. Corresponds to the JSON property sender

Returns:



2255
2256
2257
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2255

def sender
  @sender
end

#slash_command ⇒ Google::Apis::ChatV1::SlashCommand

A Slash Command in Chat. Corresponds to the JSON property slashCommand

Returns:



2260
2261
2262
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2260

def slash_command
  @slash_command
end

#space ⇒ Google::Apis::ChatV1::Space

A room or DM in Hangouts Chat. Corresponds to the JSON property space

Returns:



2265
2266
2267
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2265

def space
  @space
end

#text ⇒ String

Plain-text body of the message. Corresponds to the JSON property text

Returns:

  • (String) 


2270
2271
2272
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2270

def text
  @text
end

#thread ⇒ Google::Apis::ChatV1::Thread

A thread in Hangouts Chat. Corresponds to the JSON property thread

Returns:



2275
2276
2277
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2275

def thread
  @thread
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2282

def update!(**args)
  @action_response = args[:action_response] if args.key?(:action_response)
  @annotations = args[:annotations] if args.key?(:annotations)
  @argument_text = args[:argument_text] if args.key?(:argument_text)
  @attachment = args[:attachment] if args.key?(:attachment)
  @cards = args[:cards] if args.key?(:cards)
  @create_time = args[:create_time] if args.key?(:create_time)
  @fallback_text = args[:fallback_text] if args.key?(:fallback_text)
  @name = args[:name] if args.key?(:name)
  @preview_text = args[:preview_text] if args.key?(:preview_text)
  @sender = args[:sender] if args.key?(:sender)
  @slash_command = args[:slash_command] if args.key?(:slash_command)
  @space = args[:space] if args.key?(:space)
  @text = args[:text] if args.key?(:text)
  @thread = args[:thread] if args.key?(:thread)
end