Class: Google::Apis::CloudsearchV1::AppsDynamiteV1ApiCompatV1Attachment

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

Overview

Richly formatted attachments. Documentation: - https://api.slack.com/docs/ message-attachments

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AppsDynamiteV1ApiCompatV1Attachment

Returns a new instance of AppsDynamiteV1ApiCompatV1Attachment.



4376
4377
4378
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4376

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

Instance Attribute Details

#actionsArray<Google::Apis::CloudsearchV1::AppsDynamiteV1ApiCompatV1Action>

Array of actions (currently only buttons). Corresponds to the JSON property actions



4282
4283
4284
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4282

def actions
  @actions
end

#attachment_typeString

Undocumented - used in interactive button examples. The only valid value appears to be "default". Corresponds to the JSON property attachment_type

Returns:

  • (String)


4288
4289
4290
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4288

def attachment_type
  @attachment_type
end

#author_iconString

Avatar URL for the user. Corresponds to the JSON property author_icon

Returns:

  • (String)


4293
4294
4295
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4293

def author_icon
  @author_icon
end

URL that the user name should link to. Corresponds to the JSON property author_link

Returns:

  • (String)


4298
4299
4300
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4298

def author_link
  @author_link
end

#author_nameString

User name to display as the author of the message. Corresponds to the JSON property author_name

Returns:

  • (String)


4303
4304
4305
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4303

def author_name
  @author_name
end

#callback_idString

Unique identifier for the collection of buttons within this attachment. Will be sent back to the action handler URL when a button is clicked. Corresponds to the JSON property callback_id

Returns:

  • (String)


4309
4310
4311
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4309

def callback_id
  @callback_id
end

#colorString

A color "bar" to display to the left of the attachment. Corresponds to the JSON property color

Returns:

  • (String)


4314
4315
4316
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4314

def color
  @color
end

#fallbackString

Fallback plain-text string for clients that don't support attachments. Corresponds to the JSON property fallback

Returns:

  • (String)


4319
4320
4321
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4319

def fallback
  @fallback
end

#fieldsArray<Google::Apis::CloudsearchV1::AppsDynamiteV1ApiCompatV1Field>

Columns of text inside the attachment body. Corresponds to the JSON property fields



4324
4325
4326
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4324

def fields
  @fields
end

A string displayed at the bottom of the attachment. Corresponds to the JSON property footer

Returns:

  • (String)


4329
4330
4331
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4329

def footer
  @footer
end

Avatar URL displayed to the left of the footer. Corresponds to the JSON property footer_icon

Returns:

  • (String)


4334
4335
4336
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4334

def footer_icon
  @footer_icon
end

#image_urlString

URL of an image to display in an image chip. Corresponds to the JSON property image_url

Returns:

  • (String)


4339
4340
4341
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4339

def image_url
  @image_url
end

#mrkdwn_inArray<String>

List of fields to apply formatting to. Corresponds to the JSON property mrkdwn_in

Returns:

  • (Array<String>)


4344
4345
4346
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4344

def mrkdwn_in
  @mrkdwn_in
end

#pretextString

A string to show above the attachment. Corresponds to the JSON property pretext

Returns:

  • (String)


4349
4350
4351
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4349

def pretext
  @pretext
end

#textString

Main text. Corresponds to the JSON property text

Returns:

  • (String)


4354
4355
4356
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4354

def text
  @text
end

#thumb_urlString

URL of a thumbnail image to display to the right of the attachment body. Corresponds to the JSON property thumb_url

Returns:

  • (String)


4359
4360
4361
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4359

def thumb_url
  @thumb_url
end

#titleString

Title string of this attachment. Corresponds to the JSON property title

Returns:

  • (String)


4364
4365
4366
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4364

def title
  @title
end

URL that the title string should link to. Corresponds to the JSON property title_link

Returns:

  • (String)


4369
4370
4371
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4369

def title_link
  @title_link
end

#tsFixnum

UNIX timestamp of the attachment. Corresponds to the JSON property ts

Returns:

  • (Fixnum)


4374
4375
4376
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4374

def ts
  @ts
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 4381

def update!(**args)
  @actions = args[:actions] if args.key?(:actions)
  @attachment_type = args[:attachment_type] if args.key?(:attachment_type)
  @author_icon = args[:author_icon] if args.key?(:author_icon)
  @author_link = args[:author_link] if args.key?(:author_link)
  @author_name = args[:author_name] if args.key?(:author_name)
  @callback_id = args[:callback_id] if args.key?(:callback_id)
  @color = args[:color] if args.key?(:color)
  @fallback = args[:fallback] if args.key?(:fallback)
  @fields = args[:fields] if args.key?(:fields)
  @footer = args[:footer] if args.key?(:footer)
  @footer_icon = args[:footer_icon] if args.key?(:footer_icon)
  @image_url = args[:image_url] if args.key?(:image_url)
  @mrkdwn_in = args[:mrkdwn_in] if args.key?(:mrkdwn_in)
  @pretext = args[:pretext] if args.key?(:pretext)
  @text = args[:text] if args.key?(:text)
  @thumb_url = args[:thumb_url] if args.key?(:thumb_url)
  @title = args[:title] if args.key?(:title)
  @title_link = args[:title_link] if args.key?(:title_link)
  @ts = args[:ts] if args.key?(:ts)
end