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.



2628
2629
2630
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2628

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

Instance Attribute Details

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

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

Returns:



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

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:



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

def annotations
  @annotations
end

#argument_text ⇒ String

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

Returns:

  • (String) 


2534
2535
2536
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2534

def argument_text
  @argument_text
end

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

User uploaded attachment. Corresponds to the JSON property attachment

Returns:



2539
2540
2541
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2539

def attachment
  @attachment
end

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

Deprecated: Use cards_v2 instead. 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:



2547
2548
2549
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2547

def cards
  @cards
end

#cards_v2 ⇒ Array<Google::Apis::ChatV1::CardWithId>

Richly formatted and interactive cards that display UI elements and editable widgets, such as: - Formatted text - Buttons - Clickable images - Checkboxes - Radio buttons - Input widgets. Cards are usually displayed below the text-body of a Chat message, but can situationally appear other places, such as dialogs. The cardId is a unique identifier among cards in the same message and for identifying user input values. Currently supported widgets include: - TextParagraph - DecoratedText - Image - ButtonList - Divider Corresponds to the JSON property cardsV2

Returns:



2559
2560
2561
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2559

def cards_v2
  @cards_v2
end

#client_assigned_message_id ⇒ String

A custom name for a Chat message assigned at creation. Must start with client- and contain only lowercase letters, numbers, and hyphens up to 63 characters in length. Specify this field to get, update, or delete the message with the specified value. For example usage, see Name a created message. Corresponds to the JSON property clientAssignedMessageId

Returns:

  • (String) 


2568
2569
2570
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2568

def client_assigned_message_id
  @client_assigned_message_id
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) 


2573
2574
2575
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2573

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) 


2579
2580
2581
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2579

def fallback_text
  @fallback_text
end

#last_update_time ⇒ String

Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. Corresponds to the JSON property lastUpdateTime

Returns:

  • (String) 


2585
2586
2587
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2585

def last_update_time
  @last_update_time
end

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

A matched url in a Chat message. Chat apps can preview matched URLs. For more information, refer to Preview links. Corresponds to the JSON property matchedUrl

Returns:



2592
2593
2594
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2592

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) 


2598
2599
2600
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2598

def name
  @name
end

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

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

Returns:



2603
2604
2605
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2603

def sender
  @sender
end

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

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

Returns:



2609
2610
2611
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2609

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 app. Corresponds to the JSON property space

Returns:



2615
2616
2617
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2615

def space
  @space
end

#text ⇒ String

Plain-text body of the message. The first link to an image, video, web page, or other preview-able item generates a preview chip. Corresponds to the JSON property text

Returns:

  • (String) 


2621
2622
2623
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2621

def text
  @text
end

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

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

Returns:



2626
2627
2628
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2626

def thread
  @thread
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2633

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