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 Google Chat.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Message

Returns a new instance of Message.



2530
2531
2532
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2530

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:



2442
2443
2444
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2442

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:



2447
2448
2449
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2447

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) 


2452
2453
2454
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2452

def argument_text
  @argument_text
end

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

User uploaded attachment. Corresponds to the JSON property attachment

Returns:



2457
2458
2459
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2457

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:



2464
2465
2466
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2464

def cards
  @cards
end

#create_time ⇒ String

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

Returns:

  • (String) 


2469
2470
2471
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2469

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) 


2475
2476
2477
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2475

def fallback_text
  @fallback_text
end

#last_update_time ⇒ String

Output only. The time at which the message was last updated in Google Chat server. If the message was never updated, this field will be same as create_time. Corresponds to the JSON property lastUpdateTime

Returns:

  • (String) 


2482
2483
2484
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2482

def last_update_time
  @last_update_time
end

#matched_url ⇒ Google::Apis::ChatV1::MatchedUrl

A matched url in a Chat message. Chat bots can unfurl matched URLs. For more information, refer to Unfurl links. Corresponds to the JSON property matchedUrl

Returns:



2488
2489
2490
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2488

def matched_url
  @matched_url
end

#name ⇒ String

Resource name in the form spaces/*/messages/*. Example: spaces/AAAAAAAAAAA/ messages/BBBBBBBBBBB.BBBBBBBBBBB Corresponds to the JSON property name

Returns:

  • (String) 


2494
2495
2496
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2494

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) 


2501
2502
2503
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2501

def preview_text
  @preview_text
end

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

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

Returns:



2506
2507
2508
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2506

def sender
  @sender
end

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

A slash command in Google Chat. Corresponds to the JSON property slashCommand

Returns:



2512
2513
2514
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2512

def slash_command
  @slash_command
end

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

A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat bot. Corresponds to the JSON property space

Returns:



2518
2519
2520
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2518

def space
  @space
end

#text ⇒ String

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

Returns:

  • (String) 


2523
2524
2525
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2523

def text
  @text
end

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

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

Returns:



2528
2529
2530
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2528

def thread
  @thread
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2535

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)
  @last_update_time = args[:last_update_time] if args.key?(:last_update_time)
  @matched_url = args[:matched_url] if args.key?(:matched_url)
  @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