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.



2225
2226
2227
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2225

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:



2144
2145
2146
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2144

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:



2149
2150
2151
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2149

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) 


2154
2155
2156
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2154

def argument_text
  @argument_text
end

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

User uploaded attachment. Corresponds to the JSON property attachment

Returns:



2159
2160
2161
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2159

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:



2166
2167
2168
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2166

def cards
  @cards
end

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

Rich, formatted and interactive cards that can be used to display UI elements and editable widgets, such as: formatted text, buttons, clickable images, checkboxes, radio buttons. Cards are normally displayed below the plain-text body of the message. This v2 allows input widgets. The string key is a unique identifier among cards in the same message for identifying inputs. Corresponds to the JSON property cardsV2

Returns:



2175
2176
2177
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2175

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


2180
2181
2182
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2180

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) 


2186
2187
2188
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2186

def fallback_text
  @fallback_text
end

#name ⇒ String

Corresponds to the JSON property name

Returns:

  • (String) 


2191
2192
2193
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2191

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) 


2198
2199
2200
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2198

def preview_text
  @preview_text
end

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

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

Returns:



2203
2204
2205
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2203

def sender
  @sender
end

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

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

Returns:



2208
2209
2210
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2208

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:



2213
2214
2215
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2213

def space
  @space
end

#text ⇒ String

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

Returns:

  • (String) 


2218
2219
2220
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2218

def text
  @text
end

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

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

Returns:



2223
2224
2225
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2223

def thread
  @thread
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
 
# File 'lib/google/apis/chat_v1/classes.rb', line 2230

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