Class: Zernio::SlackPlatformData

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/slack_platform_data.rb

Overview

Slack message settings. Posts mrkdwn text (up to 40,000 chars; Slack truncates beyond that) to the channel fixed by the connected account, with up to 10 media files per post uploaded via Slack's file API (the text becomes the caption). The target channel is chosen at connect time — one connected account per channel — so channelId is NOT accepted here (a 400 is returned); connect the desired channel via /v1/connect/slack and target its accountId. Messages over 4,000 characters cannot be edited later (Slack's edit limit is stricter than its post limit).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ SlackPlatformData

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/zernio-sdk/models/slack_platform_data.rb', line 74

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::SlackPlatformData` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::SlackPlatformData`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'thread_ts')
    self.thread_ts = attributes[:'thread_ts']
  end

  if attributes.key?(:'unfurl_links')
    self.unfurl_links = attributes[:'unfurl_links']
  end

  if attributes.key?(:'unfurl_media')
    self.unfurl_media = attributes[:'unfurl_media']
  end

  if attributes.key?(:'username')
    self.username = attributes[:'username']
  end

  if attributes.key?(:'icon_url')
    self.icon_url = attributes[:'icon_url']
  end
end

Instance Attribute Details

#icon_url ⇒ Object

Override the bot avatar image URL for this message only.



32
33
34
 
# File 'lib/zernio-sdk/models/slack_platform_data.rb', line 32

def icon_url
  @icon_url
end

#thread_ts ⇒ Object

Parent message ts to post this message as a thread reply (e.g. "1503435956.000247").



20
21
22
 
# File 'lib/zernio-sdk/models/slack_platform_data.rb', line 20

def thread_ts
  @thread_ts
end

#unfurl_links ⇒ Object

Expand links in the message into preview cards. Default true.



23
24
25
 
# File 'lib/zernio-sdk/models/slack_platform_data.rb', line 23

def unfurl_links
  @unfurl_links
end

#unfurl_media ⇒ Object

Expand media links into inline previews. Default true.



26
27
28
 
# File 'lib/zernio-sdk/models/slack_platform_data.rb', line 26

def unfurl_media
  @unfurl_media
end

#username ⇒ Object

Override the bot display name for this message only (requires no setup; shown with an APP badge). Does not change the app identity in the sidebar.



29
30
31
 
# File 'lib/zernio-sdk/models/slack_platform_data.rb', line 29

def username
  @username
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



46
47
48
 
# File 'lib/zernio-sdk/models/slack_platform_data.rb', line 46

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



51
52
53
 
# File 'lib/zernio-sdk/models/slack_platform_data.rb', line 51

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



35
36
37
38
39
40
41
42
43
 
# File 'lib/zernio-sdk/models/slack_platform_data.rb', line 35

def self.attribute_map
  {
    :'thread_ts' => :'threadTs',
    :'unfurl_links' => :'unfurlLinks',
    :'unfurl_media' => :'unfurlMedia',
    :'username' => :'username',
    :'icon_url' => :'iconUrl'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/zernio-sdk/models/slack_platform_data.rb', line 151

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



67
68
69
70
 
# File 'lib/zernio-sdk/models/slack_platform_data.rb', line 67

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
 
# File 'lib/zernio-sdk/models/slack_platform_data.rb', line 56

def self.openapi_types
  {
    :'thread_ts' => :'String',
    :'unfurl_links' => :'Boolean',
    :'unfurl_media' => :'Boolean',
    :'username' => :'String',
    :'icon_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



126
127
128
129
130
131
132
133
134
 
# File 'lib/zernio-sdk/models/slack_platform_data.rb', line 126

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      thread_ts == o.thread_ts &&
      unfurl_links == o.unfurl_links &&
      unfurl_media == o.unfurl_media &&
      username == o.username &&
      icon_url == o.icon_url
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


138
139
140
 
# File 'lib/zernio-sdk/models/slack_platform_data.rb', line 138

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



144
145
146
 
# File 'lib/zernio-sdk/models/slack_platform_data.rb', line 144

def hash
  [thread_ts, unfurl_links, unfurl_media, username, icon_url].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



111
112
113
114
115
 
# File 'lib/zernio-sdk/models/slack_platform_data.rb', line 111

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/zernio-sdk/models/slack_platform_data.rb', line 173

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



119
120
121
122
 
# File 'lib/zernio-sdk/models/slack_platform_data.rb', line 119

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end