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.



3991
3992
3993
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3991

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

Instance Attribute Details

#actions ⇒ Array<Google::Apis::CloudsearchV1::AppsDynamiteV1ApiCompatV1Action>

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

Returns:



3897
3898
3899
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3897

def actions
  @actions
end

#attachment_type ⇒ String

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

Returns:

  • (String) 


3903
3904
3905
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3903

def attachment_type
  @attachment_type
end

#author_icon ⇒ String

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

Returns:

  • (String) 


3908
3909
3910
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3908

def author_icon
  @author_icon
end

#author_link ⇒ String

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

Returns:

  • (String) 


3913
3914
3915
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3913

def author_link
  @author_link
end

#author_name ⇒ String

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

Returns:

  • (String) 


3918
3919
3920
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3918

def author_name
  @author_name
end

#callback_id ⇒ String

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) 


3924
3925
3926
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3924

def callback_id
  @callback_id
end

#color ⇒ String

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

Returns:

  • (String) 


3929
3930
3931
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3929

def color
  @color
end

#fallback ⇒ String

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

Returns:

  • (String) 


3934
3935
3936
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3934

def fallback
  @fallback
end

#fields ⇒ Array<Google::Apis::CloudsearchV1::AppsDynamiteV1ApiCompatV1Field>

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

Returns:



3939
3940
3941
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3939

def fields
  @fields
end

#footer ⇒ String

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

Returns:

  • (String) 


3944
3945
3946
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3944

def footer
  @footer
end

#footer_icon ⇒ String

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

Returns:

  • (String) 


3949
3950
3951
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3949

def footer_icon
  @footer_icon
end

#image_url ⇒ String

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

Returns:

  • (String) 


3954
3955
3956
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3954

def image_url
  @image_url
end

#mrkdwn_in ⇒ Array<String>

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

Returns:

  • (Array<String>) 


3959
3960
3961
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3959

def mrkdwn_in
  @mrkdwn_in
end

#pretext ⇒ String

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

Returns:

  • (String) 


3964
3965
3966
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3964

def pretext
  @pretext
end

#text ⇒ String

Main text. Corresponds to the JSON property text

Returns:

  • (String) 


3969
3970
3971
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3969

def text
  @text
end

#thumb_url ⇒ String

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

Returns:

  • (String) 


3974
3975
3976
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3974

def thumb_url
  @thumb_url
end

#title ⇒ String

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

Returns:

  • (String) 


3979
3980
3981
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3979

def title
  @title
end

#title_link ⇒ String

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

Returns:

  • (String) 


3984
3985
3986
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3984

def title_link
  @title_link
end

#ts ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3989
3990
3991
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3989

def ts
  @ts
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 3996

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